artofscience / SAOR

Sequential Approximate Optimization Repository
GNU General Public License v3.0
5 stars 1 forks source link

Set up automated documentation using sphinx #6

Closed MaxvdKolk closed 3 years ago

MaxvdKolk commented 3 years ago

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.

artofscience commented 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.

MaxvdKolk commented 3 years ago

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.