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

QDoc can't "just do it" without overkill-configuration

    XMLWordPrintable

Details

    • Bug
    • Resolution: Out of scope
    • Not Evaluated
    • None
    • 6.1.2
    • Build tools: qdoc
    • None
    • All

    Description

      Summary

      QDoc is not zeroconf. It requires users to specify more stuff than they may need or want to.

      Steps to reproduce

      Run this from e.g. qtdeclarative repo:

      $ qdoc --outputdir ../doc-qtdeclarative-quick src/quick/doc/qtquick.qdocconf
      

      Expected output

      Something readable, like you know — webpages, in the destination directory.

      Actual output

      /home/ratijas/projects/q/qt6/qtdeclarative/src/quick/doc/src/quick/doc/qtquick.qdocconf:1: (qdoc) error: Environment variable 'QT_INSTALL_DOCS' undefined
      Environment variable 'QT_INSTALL_DOCS' undefined
      
      Aborting
      

      What the heck? I don't want to install it anywhere, especially system-wide. Can it please just build docs for me to read locally?

      Especially, error message in unclear. No environment variables were ever mentioned in --help output. But I roughly guess it depends on --installdir option.

      Alternatives

      In a certain alternative language, or rather its ecosystem one could type:

      cargo doc --open
      

      or even

      rustup doc --std
      

      to get all their documentation, right in their browser, without any extra steps or global installation paths.

      Attachments

        1. chapter 12.png
          chapter 12.png
          198 kB
        2. chapter 21.png
          chapter 21.png
          211 kB

        Issue Links

          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

              docinfrastructure Documentation Infrastructure Team
              ratijas ivan tkachenko
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Gerrit Reviews

                  There are no open Gerrit changes