search

lsst-sqre / documenteer

Sphinx extensions, configurations, and tooling for Rubin Observatory documentation projects
https://documenteer.lsst.io
MIT License
5 stars 3 forks source link

DM-26841: Improve Doxygen configuration for stack documentation #93

Closed jonathansick closed 3 years ago

jonathansick commented 3 years ago

  1. Port the base.inc, pex_config.inc and pex_exceptions.inc files from their respective packages into a Doxygen default configuration that's included with Documenteer and included in the Doxygen config via @INCLUDE_PATH and @INCLUDE Doxygen configuration tags.

  2. Embed the Doxygen tag file for cppreference.com, which was previously stored in the base package as well.

  3. Add IMAGE_PATH Doxygen configuration and make it something that can be set from individual packages.

  4. Include src/ directories and .cc files in Doxygen inputs as that matches existing usage.

  5. Add Doxygen logging configurations to DoxygenConfiguration to enable future dynamic settings.

The net effect is that the Doxygen builds controlled by Documenteer now match the functionality of sconsUtils, lsstDoxygen, etc. in terms of fully reproducing the lsst namespace.