From 0851c49e02a321c7d688b6542a90ff8a71f498c8 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Mon, 17 Feb 2025 07:41:18 +0100 Subject: Merging upstream version 2.1.2~dev0+20230529. Signed-off-by: Daniel Baumann --- docs/source/contributing/documentation.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 docs/source/contributing/documentation.md (limited to 'docs/source/contributing/documentation.md') 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` -- cgit v1.2.3