Page MenuHome

Doxygen: Integrate With CMake
Needs RevisionPublic

Authored by Aaron Carlisle (Blendify) on May 8 2020, 11:09 PM.

Details

Summary

Currently, Doxygen docs are compiled in source instead of output to the build folder.
By integrating with CMake we can output docs as part of the build.
We can also choose which modules we want to generate documentation for instead of making it hardcoded.

Note this patch is only a proof of concept and needs to be updated to use update CMake syntax

A similar approach can be used for python API docs so we can generate python API docs as part of the build process.

Resources

https://cmake.org/cmake/help/latest/module/FindDoxygen.html
https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/

Diff Detail

Event Timeline

Aaron Carlisle (Blendify) requested review of this revision.May 8 2020, 11:09 PM
Aaron Carlisle (Blendify) planned changes to this revision.
Aaron Carlisle (Blendify) created this revision.
CMakeLists.txt
446

ON for debugging

doc/doxygen/CMakeLists.txt
22

${DOXYGEN_EXECUTABLE} is deprecated use the Doxygen::doxygen import target instead.

Aaron Carlisle (Blendify) edited the summary of this revision. (Show Details)
Campbell Barton (campbellbarton) requested changes to this revision.EditedApr 8 2021, 8:51 AM

Supporting CMake is fine make doc_doxy should still work though. INPUT should probably be left as-is.

Also, we could support out-of-source builds without using CMake.

This revision now requires changes to proceed.Apr 8 2021, 8:51 AM