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
    • 7565650d8 (dev), 225aa4238 (dev), 8825ac00b (dev), 3eba4f261 (6.9), 47e043b57 (tqtc/lts-6.8), 1ecaaa373 (dev), b722d1aaf (6.10), a27dd40b5 (6.9), f37af19cd (tqtc/lts-6.8), 1740fcfcc (dev), 21992dafe (dev), 624df41e9 (6.10), 04bf3b055 (6.10)

      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
          Cristian Maureira-Fredes
        2. before.mp4
          372 kB
          Cristian Maureira-Fredes
        For Gerrit Dashboard: PYSIDE-1106
        # Subject Branch Project Status CR V
        676630,1 shiboken6/DocGenerator: Improve handling of missing detailed descriptions 6.9 pyside/pyside-setup Status: NEW +2 0
        676631,1 Documentation: Use a collapse directive for the detailed class description 6.9 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