Closed jsturdy closed 4 years ago
Uniform building of docs for legacy code:
conda
doxyrest
USE_CONDA
USE_DOXYREST
make doc
sphinx
breathe
exhale
C/C++
sphinx-autoapi
autodoc
Requests for documentation of legacy code
https://test-gemdaq-ci.web.cern.ch/test-gemdaq-ci/docs/api/xhal/latest/
Description
Uniform building of docs for legacy code:
conda
environment for python deps anddoxyrest
(if specified)USE_CONDA
andUSE_DOXYREST
can be set at docs building time to flag these behavioursUSE_CONDA
is not set, the environment from whichmake doc
is called needs all dependencies installedsphinx
breathe
+exhale
for defaultC/C++
docs, with option to usedoxyrest
breathe
outputsphinx-autoapi
for python docs automationautodoc
stubsTypes of changes
Motivation and Context
Requests for documentation of legacy code
How Has This Been Tested?
https://test-gemdaq-ci.web.cern.ch/test-gemdaq-ci/docs/api/xhal/latest/