aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/contributing/documentation.md
diff options
context:
space:
mode:
authorLibravatarDaniel Baumann <daniel.baumann@progress-linux.org>2023-06-24 19:38:25 +0200
committerLibravatarDaniel Baumann <daniel.baumann@progress-linux.org>2023-06-24 19:38:25 +0200
commitd269eb36c8f4d05fb0f8e9b8a00998dd41f0c829 (patch)
tree4268cb5c733a3b88e7c5b765a30f5b9fd81c804e /docs/source/contributing/documentation.md
parentd395bd510fa4f4376dc5237ab2f8d190a920d35d (diff)
Adding upstream version 2.1.2~dev0+20230529.upstream/2.1.2_dev0+20230529
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.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`