Re: Generate QDoc locally

 -- Qt6Tools or Qt6ToolsTools not found, not generating API documentation

could it be the issue?

Le mer. 10 déc. 2025 à 10:15, Igor Mironchik <[email protected]> a
écrit :

> Hi.
>
> No, it doesn't solve.
>
> igor@localhost:~/Work/Projects> export
> KDE_DOCS=/home/igor/Work/Projects/kde-qdoc-common
> igor@localhost:~/Work/Projects> cmake -DDOC_DESTDIR=/home/igor/doc -B
> build_md4qt md4qt
> -- The C compiler identification is GNU 15.2.1
> -- The CXX compiler identification is GNU 15.2.1
> -- Detecting C compiler ABI info
> -- Detecting C compiler ABI info - done
> -- Check for working C compiler: /usr/bin/cc - skipped
> -- Detecting C compile features
> -- Detecting C compile features - done
> -- Detecting CXX compiler ABI info
> -- Detecting CXX compiler ABI info - done
> -- Check for working CXX compiler: /usr/bin/c++ - skipped
> -- Detecting CXX compile features
> -- Detecting CXX compile features - done
> -- Installing in the same prefix as Qt, adopting their path scheme.
> fatal: upstream branch 'refs/heads/master' not stored as a remote-tracking
> branch
> -- Setting build type to 'Debug' as none was specified.
> -- Looking for __GLIBC__
> -- Looking for __GLIBC__ - found
> -- Performing Test _OFFT_IS_64BIT
> -- Performing Test _OFFT_IS_64BIT - Success
> -- Performing Test HAVE_DATE_TIME
> -- Performing Test HAVE_DATE_TIME - Success
> -- Performing Test HAVE_STDATOMIC
> -- Performing Test HAVE_STDATOMIC - Success
> -- Found WrapAtomic: TRUE
> -- Qt6Tools or Qt6ToolsTools not found, not generating API documentation
> -- Found clang-format version 21
> -- Configuring done (1.8s)
> -- Generating done (0.2s)
> CMake Warning:
>  Manually-specified variables were not used by the project:
>
>    DOC_DESTDIR
>
>
> -- Build files have been written to: /home/igor/Work/Projects/build_md4qt
> igor@localhost:~/Work/Projects> cmake -DDOC_DESTDIR=/home/igor/doc -B
> build_common kde-qdoc-common/
> CMake Warning (dev) in CMakeLists.txt:
>  No project() command is present.  The top-level CMakeLists.txt file must
>  contain a literal, direct call to the project() command.  Add a line of
>  code such as
>
>    project(ProjectName)
>
>  near the top of the file, but after cmake_minimum_required().
>
>  CMake is pretending there is a "project(Project)" command on the first
>  line.
> This warning is for project developers.  Use -Wno-dev to suppress it.
>
> CMake Warning (dev) in CMakeLists.txt:
>  cmake_minimum_required() should be called prior to this top-level
> project()
>  call.  Please see the cmake-commands(7) manual for usage documentation of
>  both commands.
> This warning is for project developers.  Use -Wno-dev to suppress it.
>
> -- The C compiler identification is GNU 15.2.1
> -- The CXX compiler identification is GNU 15.2.1
> -- Detecting C compiler ABI info
> -- Detecting C compiler ABI info - done
> -- Check for working C compiler: /usr/bin/cc - skipped
> -- Detecting C compile features
> -- Detecting C compile features - done
> -- Detecting CXX compiler ABI info
> -- Detecting CXX compiler ABI info - done
> -- Check for working CXX compiler: /usr/bin/c++ - skipped
> -- Detecting CXX compile features
> -- Detecting CXX compile features - done
> -- Installing in the same prefix as Qt, adopting their path scheme.
> -- Qt6Tools or Qt6ToolsTools not found, not generating API documentation
> -- Configuring done (0.8s)
> -- Generating done (0.0s)
> CMake Warning:
>  Manually-specified variables were not used by the project:
>
>    DOC_DESTDIR
>
>
> -- Build files have been written to: /home/igor/Work/Projects/build_common
> igor@localhost:~/Work/Projects> cmake --build build_md4qt/ -t prepare_docs
> Built target prepare_docs
> igor@localhost:~/Work/Projects> cmake --build build_common/ -t
> prepare_docs
> Built target prepare_docs
> igor@localhost:~/Work/Projects> cmake --build build_md4qt/ -t
> generate_docs
> Built target generate_docs
> igor@localhost:~/Work/Projects> cmake --build build_common/ -t
> generate_docs
> Built target generate_docs
> igor@localhost:~/Work/Projects> cmake --build build_md4qt/ -t
> install_html_docs
> Built target install_html_docs
> igor@localhost:~/Work/Projects> cmake --build build_common/ -t
> install_html_docs
> Built target install_html_docs
> igor@localhost:~/Work/Projects> cmake --build build_md4qt/ -t
> install_qch_docs
> Built target install_qch_docs
> igor@localhost:~/Work/Projects> cmake --build build_common/ -t
> install_qch_docs
> Built target install_qch_docs
>
> And after all I don't see /home/igor/docs folder... Have no idea, I should
> go for ecm_generate_qdoc(md4qt docs/md4qt.qdocconf) and look what it does,
> what's wrong there... Oh, debug CMake...
>
> On 10/12/2025 10:52, Luc Schrijvers wrote:
>
> Not sure if it's the right way but I got the next in my frameworks recipes:
>
> cmake --build build --target install_html_docs
> cmake --build build --target install_qch_docs
>
> Op wo 10 dec 2025 om 06:48 schreef Igor Mironchik <
> [email protected]>:
>
>> Maybe I miss some binaries? And prepare_docs and generate_docs just do
>> nothing...
>>
>> I have qdoc6, cmake, make... What necessary things should I have?
>> On 10/12/2025 07:38, Igor Mironchik wrote:
>>
>> Hi.
>>
>> I want to generate locally the documentation for md4qt
>> https://invent.kde.org/libraries/md4qt
>>
>> I have clone of md4qt and kde-qdoc-common
>>
>> I do:
>>
>> export KDE_DOCS=/home/igor/Work/Projects/kde-qdoc-common
>> cmake -DDOC_DESTDIR=/home/igor/doc -B build_md4qt md4qt
>> cmake -DDOC_DESTDIR=/home/igor/doc -B build_common kde-qdoc-common/
>> cmake --build build_md4qt/ -t prepare_docs
>> cmake --build build_common/ -t prepare_docs
>> cmake --build build_md4qt/ -t generate_docs
>> cmake --build build_common/ -t generate_docs
>>
>> I see messages like:
>>
>> Built target prepare_docs
>> Built target generate_docs
>>
>> But the documentation in /home/igor/docs does not appear. I dont see HTML
>> files anywhere...
>>
>> On 10/12/2025 00:55, Harald Sitter wrote:
>>
>> Hey,
>>
>> You might need to tell us what "don't work" means. Cause I've just
>> generated docs using
>>
>> export KDE_DOCS=~/src/kde-qdoc-common/
>> ninja && ninja prepare_docs && ninja generate_docs
>>
>> On Tue, Dec 9, 2025 at 5:28 AM Igor Mironchik <[email protected]> <[email protected]> wrote:
>>
>> Hi.
>>
>> How can I generate QDoc documentation locally?
>>
>> Instructions at https://invent.kde.org/sdk/kde-qdoc-common don't work.
>>
>> Thanks.
>>
>>
>>