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

Improve the documentation toolchain

    XMLWordPrintable

    Details

    • Type: User Story
    • Status: Open
    • Priority: P1: Critical
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Documentation
    • Labels:
      None

      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
      • sphinx is run to generate the HTML docs from the .rst files produced and other, fixed pages provided (tutorials etc)

        Attachments

          Issue Links

          For Gerrit Dashboard: PYSIDE-1106
          # Subject Branch Project Status CR V

            Activity

              People

              Assignee:
              kleint Friedemann Kleint
              Reporter:
              ablasche Alex Blasche
              RnD Owner:
              Alex Blasche Alex Blasche
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

                Dates

                Created:
                Updated:

                  Gerrit Reviews

                  There are no open Gerrit changes