From fe540b0464796e4f20dede8b62ee5b3736059e6c 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:32:53 +0100
Subject: [PATCH] DOC: how to contribute to doc

---
 README_SETUP.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README_SETUP.md b/README_SETUP.md
index daab4707..894777ae 100644
--- a/README_SETUP.md
+++ b/README_SETUP.md
@@ -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)
-- 
GitLab