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. after.mp4
          571 kB
        2. before.mp4
          372 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...

          For Gerrit Dashboard: PYSIDE-1106
          # Subject Branch Project Status CR V
          524026,8 shiboken6/Metabuilder: Prepare for documenting global functions dev pyside/pyside-setup Status: MERGED +2 0
          524027,9 DocGenerator: Refactor doc generation code dev pyside/pyside-setup Status: MERGED +2 0
          524028,11 DocGenerator: Refactor code preparing for generating global functions/enums dev pyside/pyside-setup Status: MERGED +2 0
          524029,11 DocGenerator: Further preparations for generating global functions/enums dev pyside/pyside-setup Status: MERGED +2 0
          524030,12 Document global functions dev pyside/pyside-setup Status: MERGED +2 0
          524452,8 Add a documentation file hint to function/enum type entries dev pyside/pyside-setup Status: MERGED +2 0
          524453,9 Extract global (non-added) function/enum documentation dev pyside/pyside-setup Status: MERGED +2 0
          524633,7 Documentation: Adapt struct ClassDocumentation for header documents dev pyside/pyside-setup Status: MERGED +2 0
          524816,23 Documentation: Use more domain directives from sphinx dev pyside/pyside-setup Status: MERGED +2 0
          525217,2 Documentation: Fix list of additional documents dev pyside/pyside-setup Status: MERGED +2 0
          525337,1 Documentation: Silence some warnings about not finding functions in webxml dev pyside/pyside-setup Status: ABANDONED 0 0
          525362,2 Silence documentation warnings about not finding signals in webxml files dev pyside/pyside-setup Status: MERGED +2 0
          525524,2 Silence documentation warnings about not finding signals in webxml files 6.6 pyside/pyside-setup Status: MERGED +2 0
          525647,2 Documentation: Fix list of additional documents 6.6 pyside/pyside-setup Status: MERGED +2 0
          525772,2 Documentation: Indicate XML parse errors to be warnings in doc_modules.py dev pyside/pyside-setup Status: MERGED +2 0
          525809,2 Documentation: Indicate XML parse errors to be warnings in doc_modules.py 6.6 pyside/pyside-setup Status: MERGED +2 0
          526874,8 Document QtQml's global function as functions dev pyside/pyside-setup Status: MERGED +2 0
          526902,5 Documentation: Enable injecting added function parameter documentation dev pyside/pyside-setup Status: MERGED +2 0
          528054,2 Documentation: Add more string types dev pyside/pyside-setup Status: MERGED +2 0
          528056,3 Documentation: Fix doc modifications for added constructors dev pyside/pyside-setup Status: MERGED +2 0
          528057,3 Documentation: Enable appending to class description dev pyside/pyside-setup Status: MERGED +2 0
          528487,10 doc: spawn many qdoc processes to build the docs dev pyside/pyside-setup Status: MERGED +2 0
          528491,3 Documentation: Add more string types 6.6 pyside/pyside-setup Status: MERGED +2 0
          528493,1 Documentation: Fix doc modifications for added constructors 6.6 pyside/pyside-setup Status: ABANDONED 0 0
          528717,3 shiboken6/Documentation: Add option to disable the inheritance diagram dev pyside/pyside-setup Status: MERGED +2 0
          528718,3 shiboken6/Documentation: Fix sphinx warnings about indexing functions with the identical names dev pyside/pyside-setup Status: MERGED +2 0
          528839,2 shiboken6/Documentation: Add option to disable the inheritance diagram 6.6 pyside/pyside-setup Status: MERGED +2 0
          531892,2 doc: spawn many qdoc processes to build the docs 6.6 pyside/pyside-setup Status: MERGED +2 0
          531975,3 doc: propagate error from qdoc_spawner dev pyside/pyside-setup Status: MERGED +2 0
          532074,2 Documentation: Generate inheritance graph only when base classes exist dev pyside/pyside-setup Status: MERGED +2 0
          532089,2 doc: propagate error from qdoc_spawner 6.6 pyside/pyside-setup Status: MERGED +2 0
          532216,2 Documentation: Generate inheritance graph only when base classes exist 6.6 pyside/pyside-setup Status: MERGED +2 0
          532420,2 doc: Fix error handling in qdoc_spawner dev pyside/pyside-setup Status: ABANDONED 0 0
          532428,7 doc: Fix error handling in qdoc_spawner dev pyside/pyside-setup Status: MERGED +2 0
          532492,2 doc: Fix error handling in qdoc_spawner 6.6 pyside/pyside-setup Status: MERGED +2 0
          532521,7 doc/qdoc_spawner: Restore behavior of bailing out when the core index file exists dev pyside/pyside-setup Status: MERGED +2 0
          544535,2 Documentation: Fix broken links to classes provided as extra documents dev pyside/pyside-setup Status: MERGED +2 0
          544536,2 Documentation: Add support for decorators dev pyside/pyside-setup Status: MERGED +2 0
          544537,2 Documentation: Change slot page to be a proper decorator dev pyside/pyside-setup Status: MERGED +2 0
          544538,2 Documentation: List loadUiType() as a function instead a class dev pyside/pyside-setup Status: MERGED +2 0
          544608,3 Documentation: Change Enum page to be a proper decorator dev pyside/pyside-setup Status: MERGED +2 0
          545677,2 doc/qdoc_spawner: Restore behavior of bailing out when the core index file exists 6.6 pyside/pyside-setup Status: MERGED +2 0
          556593,3 Documentation: Fix ClassInfo to be a proper decorator dev pyside/pyside-setup Status: MERGED +2 0
          556628,2 Documentation: Fix ClassInfo to be a proper decorator 6.7 pyside/pyside-setup Status: MERGED +2 0
          560748,2 Documentation: Add more doc file hints for QML functions dev pyside/pyside-setup Status: MERGED +2 0
          560820,2 Documentation: Add more doc file hints for QML functions 6.7 pyside/pyside-setup Status: MERGED +2 0
          593654,3 shiboken6/Documentation: Enable running QtXmlToSphinx on a QIODevice dev pyside/pyside-setup Status: MERGED +2 0
          593655,25 shiboken6/Documentation: Fix resolving images in the overview pages dev pyside/pyside-setup Status: MERGED +2 0
          593742,6 shiboken6: Pass the target directory to the generator functions dev pyside/pyside-setup Status: MERGED +2 0
          593773,5 shiboken6/Documentation: Return documention source file from the DocParser (doxygen/qdoc) dev pyside/pyside-setup Status: MERGED +2 0
          594123,5 shiboken6/Documentation: Add source file to the Documentation class dev pyside/pyside-setup Status: MERGED +2 +1
          594247,10 shiboken6/Documentation: Introduce a doc-package typesystem attribute dev pyside/pyside-setup Status: MERGED +2 0
          594272,9 shiboken6/Documentation: Extract images from the .rst module descriptions dev pyside/pyside-setup Status: MERGED +2 0
          594277,4 shiboken6/Documentation: Fix WebXML module documentation name dev pyside/pyside-setup Status: MERGED +2 0
          594465,2 shiboken6/Documentation: Add doc-package attribute for QtOpenGLWidgets dev pyside/pyside-setup Status: MERGED +2 0
          594467,2 shiboken6/Documentation: Fix a syntax error in the modules list dev pyside/pyside-setup Status: MERGED +2 0
          594509,1 shiboken6/Documentation: Add doc-package attribute for QtOpenGLWidgets dev pyside/pyside-setup Status: ABANDONED +2 0
          594553,3 shiboken6/Documentation: Fix a syntax error in the modules list 6.7 pyside/pyside-setup Status: MERGED +2 0
          594840,2 shiboken6/Documentation: Add doc-package attribute for QtQuick Controls2 dev pyside/pyside-setup Status: MERGED +2 0
          596347,3 shiboken6/Documentation: Fix missing classes in QWebEngineCore TOC dev pyside/pyside-setup Status: MERGED +2 0
          596399,2 shiboken6/Documentation: Fix missing classes in QWebEngineCore TOC 6.8 pyside/pyside-setup Status: MERGED +2 0
          597538,3 build: Install module doc snippet files dev pyside/pyside-setup Status: MERGED +2 +1
          597539,2 PySide6/Documentation: Name the .rst doc files according to the module name dev pyside/pyside-setup Status: MERGED +2 0
          597779,2 PySide6/Documentation: Name the .rst doc files according to the module name 6.8 pyside/pyside-setup Status: MERGED +2 0
          597885,2 build: Install module doc snippet files 6.8 pyside/pyside-setup Status: MERGED +2 0
          599006,4 WIP: Documentation: Fix inherited-by and other links for classes in namespaces dev pyside/pyside-setup Status: ABANDONED -2 0
          599280,19 shiboken6/Documentation: Nest inner classes' pages into outer classes dev pyside/pyside-setup Status: MERGED +2 0
          599394,12 shiboken6: Refactor class generation to allow for flexible handling of inner classes dev pyside/pyside-setup Status: MERGED +2 0
          599838,2 shiboken6: Refactor class generation to allow for flexible handling of inner classes 6.8 pyside/pyside-setup Status: MERGED +2 0
          599891,2 shiboken6/Documentation: Nest inner classes' pages into outer classes 6.8 pyside/pyside-setup Status: MERGED +2 0
          605908,12 Documentation/example gallery: Handle tutorials dev pyside/pyside-setup Status: MERGED +2 0
          605935,2 Documentation: Fix qdoc to run 6.8 pyside/pyside-setup Status: MERGED +2 0
          605942,2 Documentation: Fix qdoc to run dev pyside/pyside-setup Status: MERGED +2 0
          606518,2 Documentation: Fix test example path dev pyside/pyside-setup Status: MERGED +2 0
          606542,2 Documentation: Fix test example path 6.8 pyside/pyside-setup Status: MERGED +2 0
          607254,9 shiboken6: Add a documentation file hint to complex type entries dev pyside/pyside-setup Status: MERGED +2 0
          607361,7 PySide: Fix some missing documentation dev pyside/pyside-setup Status: MERGED +2 0
          607446,2 shiboken6: Add a documentation file hint to complex type entries 6.8 pyside/pyside-setup Status: MERGED +2 0
          607447,2 PySide: Fix some missing documentation 6.8 pyside/pyside-setup Status: MERGED +2 0
          609721,2 Documentation/example gallery: Handle tutorials 6.8 pyside/pyside-setup Status: MERGED +2 0
          610167,3 shiboken6/Documentation: Disambiguate additional document target file name dev pyside/pyside-setup Status: MERGED +2 0
          610168,6 Documentation: Add groups dev pyside/pyside-setup Status: MERGED +2 0
          610256,2 shiboken6/Documentation: Disambiguate additional document target file name 6.8 pyside/pyside-setup Status: MERGED +2 0
          610355,4 Developer Documentation: Improve sections on additional documentation files dev pyside/pyside-setup Status: MERGED +2 0
          610367,5 Documentation: Update basic module pages dev pyside/pyside-setup Status: MERGED +2 0
          610392,2 Developer Documentation: Improve sections on additional documentation files 6.8 pyside/pyside-setup Status: MERGED +2 0
          610394,2 Documentation: Add groups 6.8 pyside/pyside-setup Status: MERGED +2 0
          610901,2 Documentation: Update basic module pages 6.8 pyside/pyside-setup Status: MERGED +2 0
          610920,14 Documentation: Update QtQml/QtQuick modules dev pyside/pyside-setup Status: MERGED +2 0
          610922,5 Developer documentation: Describe how to adapt generated Qt documentation to PySide dev pyside/pyside-setup Status: MERGED +2 0
          611125,6 shiboken6: Remove unused code from the doc parsers dev pyside/pyside-setup Status: MERGED +2 0
          611133,11 shiboken6/Documentation: Prominently display QML types dev pyside/pyside-setup Status: MERGED +2 0
          611386,6 shiboken/Documentation: Remove C++ -specific sections from the WebXML module descriptions dev pyside/pyside-setup Status: MERGED +2 0
          611456,2 shiboken6: Remove unused code from the doc parsers 6.8 pyside/pyside-setup Status: MERGED +2 0
          611613,2 Developer documentation: Describe how to adapt generated Qt documentation to PySide 6.8 pyside/pyside-setup Status: MERGED +2 0
          611614,2 shiboken6/Documentation: Prominently display QML types 6.8 pyside/pyside-setup Status: MERGED +2 0
          611615,2 Documentation: Update QtQml/QtQuick modules 6.8 pyside/pyside-setup Status: MERGED +2 0
          611616,2 shiboken/Documentation: Remove C++ -specific sections from the WebXML module descriptions 6.8 pyside/pyside-setup Status: MERGED +2 0
          612019,4 shiboken/Documentation: Remove more C++ -specific sections from the WebXML module descriptions dev pyside/pyside-setup Status: MERGED +2 0
          612250,2 shiboken/Documentation: Remove more C++ -specific sections from the WebXML module descriptions 6.8 pyside/pyside-setup Status: MERGED +2 0

          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