aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/contributing/documentation.md
diff options
context:
space:
mode:
authorLibravatarDaniel Baumann <daniel@debian.org>2025-02-17 07:41:18 +0100
committerLibravatarDaniel Baumann <daniel@debian.org>2025-02-17 07:41:18 +0100
commit0851c49e02a321c7d688b6542a90ff8a71f498c8 (patch)
tree67d787608695391e5edc2eb245b3943302ba1734 /docs/source/contributing/documentation.md
parent4e4bfe759938fe0e17da559edfeee7b73969daf3 (diff)
Merging upstream version 2.1.2~dev0+20230529.
Signed-off-by: Daniel Baumann <daniel@debian.org>
Diffstat (limited to 'docs/source/contributing/documentation.md')
-rw-r--r--docs/source/contributing/documentation.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/source/contributing/documentation.md b/docs/source/contributing/documentation.md
new file mode 100644
index 0000000..cd72b85
--- /dev/null
+++ b/docs/source/contributing/documentation.md
@@ -0,0 +1,14 @@
+# Documentation contributions
+
+## Build
+
+We use Sphinx to create the documentation from source files and docstrings in code.
+
+ pip install -r docs/requirements.txt
+ python setup.py build_docs
+
+The resulting html files are in `docs/build/html`.
+
+## man pages
+
+Located in `docs/man`