Select a documentation generation tool

[barbourshop]

Goal: To choose a tool to autogenerate HTML documentation from code.

Potentially suitable tools to evaluate

• Doxygen
  • example using Doxygen to document pyton
• Sphinx

Acceptance Criteria:

• output must be in an HTML format suitable for display via Github pages
• documentation generation process must be completable via gh action

[TB-1993]

The current suggestion for this is to use a combination of Doxygen and Sphinx using the Breathe plugin for Sphinx.

So far we've found that Doxygen will collate documents together better/easier than sphinx, but the documentation and styling sphinx provides is more standard for python and doesn't require us to use non-pythonic comments in our docstrings.