This is an offer of help, but before I get started I want to know if the contribution would be welcome: I suggest creating documentation for this project using mkdocs (https://www.mkdocs.org/). This allows webpage generation from Python docstrings. It can be ran using Github Actions, so that every time a change is pushed to master the documentation will be automatically updated. It is also possible to include tutorials written as a Jupyter Notebook. We implemented similar for ThermoPot (https://github.com/NU-CEM/ThermoPot).
If @JMSkelton and team would welcome the contribution, I will fork the master branch and then put in a PR once implemented.
Hello,
This is an offer of help, but before I get started I want to know if the contribution would be welcome: I suggest creating documentation for this project using mkdocs (https://www.mkdocs.org/). This allows webpage generation from Python docstrings. It can be ran using Github Actions, so that every time a change is pushed to master the documentation will be automatically updated. It is also possible to include tutorials written as a Jupyter Notebook. We implemented similar for ThermoPot (https://github.com/NU-CEM/ThermoPot).
If @JMSkelton and team would welcome the contribution, I will fork the master branch and then put in a PR once implemented.