aboutsummaryrefslogtreecommitdiff
path: root/docs/contributor_guide/build_documentation.md
diff options
context:
space:
mode:
authorThéo de la Hogue2023-06-06 17:46:24 +0200
committerThéo de la Hogue2023-06-06 17:46:24 +0200
commitb109578ec1e8635aeb9f12c3a913108232347935 (patch)
tree27b309b6b5dfabc12b0d1c57cd43efc6ab6a35a3 /docs/contributor_guide/build_documentation.md
parentfafa4b7e12147bab945a4b84ded53c6171d20427 (diff)
downloadargaze-b109578ec1e8635aeb9f12c3a913108232347935.zip
argaze-b109578ec1e8635aeb9f12c3a913108232347935.tar.gz
argaze-b109578ec1e8635aeb9f12c3a913108232347935.tar.bz2
argaze-b109578ec1e8635aeb9f12c3a913108232347935.tar.xz
Working on documentation architecture.
Diffstat (limited to 'docs/contributor_guide/build_documentation.md')
-rw-r--r--docs/contributor_guide/build_documentation.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/contributor_guide/build_documentation.md b/docs/contributor_guide/build_documentation.md
new file mode 100644
index 0000000..20df1df
--- /dev/null
+++ b/docs/contributor_guide/build_documentation.md
@@ -0,0 +1,23 @@
+Build documentation
+===================
+
+ArGaze has a standard MkDocs layout which is built by Read the Docs. You can build and view this documentation project locally.
+
+!!! note
+
+ *Consider that all inline commands below have to be executed into ArGaze root folder.*
+
+Install required Python dependencies (MkDocs etc.):
+```console
+pip install -r docs/requirements.in
+```
+
+Run the mkdocs development server:
+```console
+mkdocs serve
+```
+
+Export the mkdocs site:
+```console
+mkdocs build
+```