diff --git a/src/doc/README_SETUP.md b/src/doc/README_SETUP.md index b6995c9a2d950ecd1e832d5b49dac9ed88a7e455..1df6639d8716f1adf8f6da1833e34c034b0ca8d2 100644 --- a/src/doc/README_SETUP.md +++ b/src/doc/README_SETUP.md @@ -70,6 +70,8 @@ pip3 install --user . ## Run Unit Tests ## Documentation ## +We use sphinx to create the documentation. Docstrings in the code should comply +with the Googly style (see link below). Build documentation in `src/doc` with `make html`. @@ -79,4 +81,10 @@ Build documentation in `src/doc` with `make html`. - `sphinx-autoapi` - `recommonmark` -### Troubleshooting ### +### How to contribute ### + +- [Google Style Python Docstrings](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) +- [Google Style Python Docstrings 2nd reference](https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings) +- [References to other documentation](https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#role-external) + +