Documentation w/ Sphinx

[rdoddanavar]

Use sphinx to generate HTML documentation; consider integrating with GH Actions, and/or hosting on GH Pages; use "readthedocs" theme for familiarity

[rdoddanavar]

Sphinx help:

• https://tech.michaelaltfield.net/2020/07/18/sphinx-rtd-github-pages-1/
• https://stackoverflow.com/questions/62626125/github-pages-with-sphinx-generated-documentation-not-displaying-html-correctly
• https://www.sphinx-doc.org/en/master/usage/extensions/math.html

Targeting a different subdirectory for GH Pages:

• https://gist.github.com/joshuapekera/ef364073b01fb0e21d3f
• https://stackoverflow.com/questions/36782467/set-subdirectory-as-website-root-on-github-pages
• https://gist.github.com/cobyism/4730490
• http://sangsoonam.github.io/2019/02/08/using-git-worktree-to-deploy-github-pages.html

[rdoddanavar]

Help w/ markdown on sphinx:

• https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html
• https://myst-parser.readthedocs.io/en/latest/index.html
• https://myst-parser.readthedocs.io/en/latest/syntax/optional.html

[rdoddanavar]

Good resource for combining sphinx and doxygen: https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/

[rdoddanavar]

Creating an empty gh-pages branch to host documentation:

• https://gist.github.com/ramnathv/2227408
• https://stackoverflow.com/questions/8815294/creating-github-pages-repo/8815361#8815361
• https://jiafulow.github.io/blog/2020/07/09/create-gh-pages-branch-in-existing-repo/