Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-32580

QDoc: Restore support for outputting to a single directory

    XMLWordPrintable

Details

    • 67697ecfd4be9b9835bfda1c47562f5e5e349134, 68218ea38d34ad93055f022b40c193c162e35879, 7f777897715290573ebdc580eb4e9fdc0bee3de6

    Description

      Get QDoc to output HTML files onto a single directory.

      Before Qt 5.0, QDoc naturally outputted its generated HTML files onto a single directory.

      This would help the canonization of documentation URLs to doc/qt/ and as a result:
      -better usability for people entering HTML filenames
      -better search results as Google prefers canonized URLs

      There should be an option to turn this on in QDoc. The modularized documentation should be the default for packaging and the non-modularized build just for the website.

      Things to consider:
      -the relative links from one module to another in the HTML generator.
      -the collision pages and pages with the same filenames (small risk as this was communicated a long time ago).

      Attachments

        Issue Links

          depends on

          Bug - A problem which impairs or prevents the functions of the product. QTBUG-32881 Qt Sensors Grue and Explorer examples generate QDoc warnings

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

          Bug - A problem which impairs or prevents the functions of the product. QTBUG-32935 QDoc is having problems with an internal class with a \relates command

          • 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. QTBUG-32990 QDoc: Extra "module.html" pages created

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

          Task - A task that needs to be done. QTBUG-32173 Qt 5.2 Documentation Issues (meta bug)

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed
          For Gerrit Dashboard: QTBUG-32580
          # Subject Branch Project Status CR V
          62431,3 qdoc: Restore support for output in one directory dev qt/qtbase Status: MERGED -1 0
          62568,1 Doc: Renamed HTML file for "Qt Multimedia on Windows" page. dev qt/qtmultimedia Status: MERGED +2 0
          62578,2 Doc: Moved QML "plugins" example to "qmlextensionplugins" dev qt/qtdeclarative Status: MERGED +2 0
          62615,1 Doc: Removed extra "\group events" page in Qt GUI. dev qt/qtbase Status: MERGED -1 0
          62651,1 Doc: Fixed qmake manual's images and snippets directories. dev qt/qtbase Status: MERGED +2 0
          62663,1 qdoc: Let default output subdir be html dev qt/qtbase Status: MERGED +2 0
          62673,1 Doc: removed unnecessary page about plugins. dev qt/qtdoc Status: MERGED +2 0
          62803,2 Doc: Renamed and moved examples/qml/i18n to examples/qml/qml-i18n dev qt/qtdeclarative Status: MERGED +2 0
          62827,1 Doc: Renamed accessibility example to "quick-accessibility". dev qt/qtdeclarative Status: MERGED +2 0
          62828,2 Doc: Renamed list of example page to "Item Views Example". dev qt/qtbase Status: MERGED +2 0
          62829,1 Doc: Removed "Item Views Example" page. dev qt/qtdoc Status: MERGED +2 0
          62984,3 Doc: Renamed "gallery" example to "controls" dev qt/qtquickcontrols Status: ABANDONED +2 0
          63010,2 Doc: Removed containers group page. dev qt/qtquickcontrols Status: MERGED +2 0
          63058,2 Doc: Changed exampledir variable in qdocconf file. dev qt/qtquickcontrols Status: ABANDONED 0 0
          63270,5 qdoc: Make example file names unique dev qt/qtbase Status: MERGED +2 0
          63612,2 qdoc: Fixed the relative link to installdir problem dev qt/qtbase Status: MERGED +2 0

          Activity

            People

              gbk Martin Smith (Qt)
              jerome.pasion Jerome Pasion
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: