Doxygen: add navigation tabs to other LALSuite packages to each package documentation (!2117) · Merge requests · lscsoft / lalsuite

Two improvements to the Doxygen documentation:

Adds navigation tabs to other LALSuite packages at the top of each Doxygen documentation HTML page. This replaces the current hacky iframe container, which only works for the top-level documentation.
Add a proper landing page for LALSuite itself. To do this run, run the same Doxygen configuration as for the packages in a top-level /doxygen directory. The LALSuite documentation page only contains the top-level README.md and CONTRIBUTING.md, but also contains the same navigation tabs to other LALSuite packages. The search bar from the LALSuite documentation page will also find symbols in other LALSuite packages. (It was for the latter reason that the current iframe container defaults to pointing to LALApps, as the last in the dependency chain. Having a separate documentation page for LALSuite itself is a cleaner solution.) I also moved the LAL Specification and Style Guide, and the SWIG tutorial, to the top-level LALSuite documentation, and a more visible/easier location to find these (and other general-purpose documentation) than being buried in the library-level documentation hierarchies.

I also played around with the colour scheme, and ended up settling on a greenish tint (by using (20)15-09-14 as numerical colour values).

A screenshot probably makes the changes clearer, see below. Or you can browse a documentation build here.

This change does not modify any class/function/struct/type definitions in a public C header file or any Python class/function definitions
This change adds new classes/functions/structs/types to a public C header file or Python module

This change modifies an existing class/function/struct/type definition in a public C header file or Python module
This change removes an existing class/function/struct/type from a public C header file or Python module

n/a

Edited Mar 24, 2023 by Karl Wette

Admin message