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

DOC: how to contribute to doc

parent f9fa6e57
Branches
Tags
2 merge requests!65DOC: Added CITATION.cff to the list of files in the release guide where the...,!61F how to doc
Pipeline #30460 passed
......@@ -52,6 +52,8 @@ Optional h5-crawler:
`make style`
## 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`.
......@@ -60,3 +62,9 @@ Build documentation in `build/` with `make doc`.
- `sphinx`
- `sphinx-autoapi`
- `recommonmark >= 0.6.0`
### 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)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment