Documentation (work in progress)

[hjjvandam]

Adding a workflow to generate source code documentation using Doxygen (Sphinx was the other option but that mixes a bunch of configuration files with the source code, which is messy). As far as I am able to test this set up it successfully generates the documentation in HTML format. However, at present the contents are limited by the fact that the code does not contain any doc-strings to generate documentation from.

In the current set up the documentation is automatically pushed to a GitHub Pages branch on the repo (gh-pages). On the first attempt there are likely going to be some issues as a few additional configuration steps on the gh-pages branch are required (https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-first-deployment-with-github_token).

[hjjvandam]

GitHub Pages is a bit interesting. So you can generate documentation and upload it to GitHub Pages, but that is not enough to read the documentation. To read the documentation you have to clone the gh-pages branch of the repo and open index.html in a browser. The advantage is that only those people who have access to the source code also have access to the documentation.

Alternatively we can set something up on github.io. However, all information shared there is publicly accessible. There does not seem to be a private option.