HomePhabricator

[CMAKE] Fix doxygen generation

Description

[CMAKE] Fix doxygen generation

Summary:
When looking at D8061, it appeared that the doxygen documentation
generation was broken. The template file use relative paths which are
invalid once run from the build directory as documented. This diff fixes
the doxygen generation in several ways:

  • It moves the doxygen files to their own directory doc/doxygen
  • It uses CMAKE_SOURCE_DIR and CMAKE_BINARY_DIR to no longer rely on the callsite location
  • It adds a gen-doxygen target to actually build the doc
  • It updates the documentation accordingly
  • It builds the docs on CI to check for regression

Test Plan:

ninja doc-doxygen

Look at the output in your build dir under doc/doxygen/html.

./contrib/teamcity/build-configurations.py build-docs

Reviewers: #bitcoin_abc, PiRK

Reviewed By: PiRK

Subscribers: PiRK

Differential Revision: https://reviews.bitcoinabc.org/D8074

Details

Provenance
FabienAuthored on Oct 23 2020, 09:10
FabienPushed on Oct 23 2020, 12:19
Reviewer
PiRK
Differential Revision
D8074: [CMAKE] Fix doxygen generation
Parents
rABCbcfcc43e5915: [gui] load PSBT
Branches
Unknown
Tags
Unknown