From 05c6583db8eb983dbc690c5384046d345c245d79 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Henrik=20tom=20W=C3=B6rden?= <h.tomwoerden@indiscale.com>
Date: Sun, 13 Nov 2022 19:30:12 +0100
Subject: [PATCH] DOC: how to contribute to doc

---
 src/doc/README_SETUP.md | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/src/doc/README_SETUP.md b/src/doc/README_SETUP.md
index b6995c9a..1df6639d 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)
+
+
-- 
GitLab