Closed MaxvdKolk closed 3 years ago
I suggest we all @aatmdelissen , @Giannis1993 , @MaxvdKolk read
As indicated in one of the comments on PR #3, lets set up documentation tools using Sphinx: https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html.
Can be set up like
docs/build/ # where the generated output will be placed docs/source/ # containing the .rst source files
The documentation in
docs/build/
can be generated automatically from placed docstrings in the code.
and the link herein, comment the current and new code accordingly.
This issue can be closed, as it was merged previously. We can make a new issue once the code is more stable to finalise the documentation and along the way of implementing the features make sure to include docstrings etc.
As indicated in one of the comments on PR #3, lets set up documentation tools using Sphinx: https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html.
Can be set up like
The documentation in
docs/build/
can be generated automatically from placed docstrings in the code.