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

Adding an official documentation of building Qt documentation from source

    XMLWordPrintable

Details

    • 99dc3f757 (dev), 3178d3d2d (6.8), d35af40d2 (6.7), cf4cca8f4 (tqtc/lts-6.5), bddcc18b9 (tqtc/lts-6.2), 5bd2b5bc4 (tqtc/lts-5.15)
    • DaVinci 101

    Description

      Right now, users are either referring to README in Qt source, i.e. this part:

      Documentation
      =============
       
      After configuring and compiling Qt, building the documentation is possible by running
       
      ```
      cmake --build . --target docs
      ```
       
      After having built the documentation, you need to install it with the following
      command:
       
      ```
      cmake --build . --target install_docs
      ```
       
      The documentation is installed in the path specified with the
      configure argument `-docdir`.
      

      Or to a Wiki page:
      https://wiki.qt.io/Building_Qt_Documentation

      The problems are:
      1. They are purposing seemingly different approaches and can be confusing
      2. Neither is that "official" or easy to find. I suppose doc.qt.io is the place to go when user wants to find something (especially, building something from source)?

      So it may be better to integrate those 2 articles into doc.qt.io, explaining what options people can have when try to build Qt doc by themselves.

      Attachments

        For Gerrit Dashboard: QTBUG-127283
        # Subject Branch Project Status CR V

        Activity

          People

            andreas.eliasson Andreas Eliasson
            luqiaochen Luqiao Chen
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews