summaryrefslogtreecommitdiffstats
path: root/comm/docs/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'comm/docs/README.md')
-rw-r--r--comm/docs/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/comm/docs/README.md b/comm/docs/README.md
new file mode 100644
index 0000000000..4ffb083903
--- /dev/null
+++ b/comm/docs/README.md
@@ -0,0 +1,18 @@
+# Building documentation locally
+
+This process will improve over time.
+
+For now, manually create a Python virtual environment and install the
+dependencies:
+
+```shell
+make venv
+```
+
+The virtualenv will be created in **_venv**.
+
+Then to build the documentation:
+
+```shell
+make html
+```