Uploaded image for project: 'Qt for Python'
  1. Qt for Python
  2. PYSIDE-1106

Improve the documentation toolchain

XMLWordPrintable

    • Icon: User Story User Story
    • Resolution: Unresolved
    • Icon: P1: Critical P1: Critical
    • None
    • None
    • Documentation
    • None
    • 4315cfb44 (dev), 04ebdcb6e (6.4), 4caf38c27 (tqtc/lts-6.2), 0479b02b6 (dev), 4fbcfa43a (6.4), 088acf9ae (dev), 985c281c2 (6.4), 99f1b42b3 (dev), e48afcb0d (6.4), 3c60c8efa (tqtc/lts-6.2), 2160cefd6 (dev), c2c11d067 (dev), 7565650d8 (dev), 225aa4238 (dev)

      Building the documentation requires the following steps: https://wiki.qt.io/Qt_for_Python/GettingStarted#Building_the_Documentation

      The toolchain works as follows:

      • qdoc is run with .webxml output format
      • shiboken runs over the webxml pages and extracts the parts for which bindings exist (according to its type system) and potentially applies modifications and outputs .rst
      • Referenced C++ code snippets are translated to Python using a regexp-based tool
      • sphinx is run to generate the HTML docs from the .rst files produced and other, fixed pages provided (tutorials etc)

        1. after.mp4
          571 kB
        2. before.mp4
          372 kB
        For Gerrit Dashboard: PYSIDE-1106
        # Subject Branch Project Status CR V
        673750,4 shiboken6/DocGenerator: Extract a helper function to write detailed description dev pyside/pyside-setup Status: NEW 0 0
        673751,6 WIP: Documentation: Use a collapse directive for the detailed class description dev pyside/pyside-setup Status: NEW -2 0

            kleint Friedemann Kleint
            ablasche Alex Blasche
            Alex Blasche Alex Blasche
            Votes:
            0 Vote for this issue
            Watchers:
            7 Start watching this issue

              Created:
              Updated:

                There are 2 open Gerrit changes