Skip to content
Snippets Groups Projects
Commit 64aae359 authored by Henrik tom Wörden's avatar Henrik tom Wörden
Browse files

DOC: how to contribute to doc

parent ae3f5599
No related branches found
No related tags found
2 merge requests!93Release 0.11.0,!78F how to doc
Pipeline #30461 passed
......@@ -109,6 +109,8 @@ Now would be a good time to continue with the [tutorials](tutorials/index).
- Run a specific test function: e.g. `tox -- unittests/test_schema.py::test_config_files`
## Documentation ##
We use sphinx to create the documentation. Docstrings in the code should comply
with the Googly style (see link below).
Build documentation in `build/` with `make doc`.
......@@ -118,5 +120,11 @@ Build documentation in `build/` with `make doc`.
- `sphinx-autoapi`
- `recommonmark`
### 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)
### Troubleshooting ###
If the client is to be executed directly from the `/src` folder, an initial `.\setup.py install --user` must be called.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment