Feature: doc generation
One of the main goals of our project is to document our work and to provide a systematic way for this project's maintainers to keep adding documentation.
This merge request incorporates the elements of my previous one, but now Doxygen is responsible for everything related to generating documentation. This includes:
- code-level documentation
- UML diagrams
- any other Markdown-formatted documentation files
DOCUMENTATION.md file that I included in this branch should explain all of the details about what documentation gets created. Once this branch gets merged to
master, the pipeline should continually publish the generated docs to a static site powered by GitLab Pages (may have to tweak things with TRIUMF IT if it doesn't work as intended the first time around).
How was this tested?
make docs job locally (Linux environment) and in the pipeline, which should be visible in the history for this branch
Also browsed around the generated static site and made sure it's usable -- there are lots of styling and layout options that we could tweak but the defaults are solid and the
Doxyfile has thorough explanations for whoever wants to look into that in the future.