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

Merge branch 'f-how-to-doc' into 'dev'

how to doc

See merge request !68
parents ec5cbaba 05c6583d
No related branches found
No related tags found
2 merge requests!91Release 0.3,!68how to doc
Pipeline #30743 passed
...@@ -70,6 +70,8 @@ pip3 install --user . ...@@ -70,6 +70,8 @@ pip3 install --user .
## Run Unit Tests ## Run Unit Tests
## Documentation ## ## 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`. Build documentation in `src/doc` with `make html`.
...@@ -79,4 +81,10 @@ Build documentation in `src/doc` with `make html`. ...@@ -79,4 +81,10 @@ Build documentation in `src/doc` with `make html`.
- `sphinx-autoapi` - `sphinx-autoapi`
- `recommonmark` - `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)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment