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

Documentation Improvement

XMLWordPrintable

    • Icon: User Story User Story
    • Resolution: Fixed
    • Icon: P3: Somewhat important P3: Somewhat important
    • None
    • None
    • Documentation
    • None
    • All
    • 44385439c (dev), f85114909 (dev), a12fbe8cf (dev), e3c2d8d1c (dev), 1d1274a57 (dev), 3f78f5f1a (dev), 915644419 (dev), d2318d7aa (dev), ffa9e4978 (dev)

      There are a lot of sections in the documentation that can be improved. This User Story resulted from many past discussions and https://bugreports.qt.io/browse/PYSIDE-2833

       

      Some of the things targetted:

      • Use sphinx references consistently across the documentation. Currently relative paths are used which can break documentation when file name or paths are changed.
      • Add warning checks for missing references to easily identify cross reference errros.
      • Fix expired or invalid links in the base documentation

      More issues will be added and fixed as they are identified.

       

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

            shpremna Shyamnath Premnadh
            shpremna Shyamnath Premnadh
            Vladimir Minenko Vladimir Minenko
            Cristian Maureira-Fredes Cristian Maureira-Fredes
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved:

                There are no open Gerrit changes