Skip to content

Restructure common doxygen build elements

Duncan Macleod requested to merge duncanmmacleod/lalsuite:top-level-doxygen into master

Description

This MR restructures the common Doxygen build elements into a new top-level directory /doxygen/, whose contents are symlinked into the subpackage directories (rather than packages symlinking from /lal/doxygen/). A small README.md has been placed in /doxygen/ to explain how the builds are performed, but it doesn't say much at this point.

The only real change is that the /lal/doxygen/Makefile.am has been moved to /gnuscripts/lalsuite_doxygen.am and a boilerplate file that just includes that file put in its place for each subpackage. In principle this should allow customisation of the doxygen build for each subpackage, but whether anyone actually wants to do that is up for debate.

This should have zero overall impact on any builds, but may help with repository maintenance.

API Changes and Justification

Backwards Compatible Changes

  • This change introduces no API changes
  • This change adds new API calls

Backwards Incompatible Changes

  • This change modifies an existing API
  • This change removes an existing API

If any of the Backwards Incompatible check boxes are ticked please provide a justification why this change is necessary and why it needs to be done in a backwards incompatible way.

Review Status

Please provide details on any reviews related to this change and and the associated reviewers.

Merge request reports