Auto-generate documentation site
Summary of Changes
Uses Sphinx to build a docsite for our application development process and pushes it to readthedocs.org.
I've also heavily revised the docstrings for this module in order to use reST/numpy style for auto-generation of the API.
Lastly, I've snuck in the swap to mvvm-lib here since it's not a functional change and very small. Happy to split it into a separate MR if desired.
I'm aware of a couple of issues that I don't know how to resolve, yet (advice is welcome!):
- The doc pipeline passes regardless of whether or not the readthedocs build succeeds.
- I need to manually tag a branch right now in order to get readthedocs to produce a versioned, stable build.
This is in draft mode because I think both of these are important enough to fix before merge.
Checklist
-
The MR has a clear and concise title -
Code is self-documented and follows style guidelines. -
Automated tests are written and pass successfully. -
Regression tests (e.g. manually triggered system tests, manual GUI/tool tests, ...) are performed to make sure the MR does not break anything (when applicable) -
Readme file is present and up-to-date.
Documentation Updates
https://nova-application-development.readthedocs.io/en/latest/ will be built on every MR merge (regardless of version changes) and can be built manually by the developer as needed with a manual pipeline. https://nova-application-development.readthedocs.io/en/stable/ will be built if the MR has a version change once the MR is merged.
Additional Notes
Closes #23 (closed)