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

Improve the documentation toolchain

    XMLWordPrintable

Details

    • User Story
    • Resolution: Unresolved
    • 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)

    Description

      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)

      Attachments

        1. before.mp4
          372 kB
        2. after.mp4
          571 kB

        Issue Links

          relates to

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. PYSIDE-1112 Improve Qt for Python documentation

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Open

          Bug - A problem which impairs or prevents the functions of the product. QTBUG-86987 qdoc doesn't recognize hidden friends as available APIs

          • P3: Somewhat important - Should be fixed, but doesn't affect the release in any way.
          • Closed

          Bug - A problem which impairs or prevents the functions of the product. PYSIDE-2111 A lot of pages look like an automatic translation of the C++ documentation

          • P4: Low - Would be nice to fix, but it's not very important.
          • Closed
          mentioned in

          Page Loading...

          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

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

              Dates

                Created:
                Updated:

                Gerrit Reviews

                  There are no open Gerrit changes