instructions for local build

uit-no · Sep 25, 2015 · a9ec2d0 · a9ec2d0
1 parent 5f588a9
commit a9ec2d0
Showing 1 changed file with 17 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,7 @@
-HPC-group user documentation
-served via
-http://hpc-uit.readthedocs.org.
+
+# HPC-group user documentation
+
+Served via http://hpc-uit.readthedocs.org.
 
 Copyright (c) 2015
 Radovan Bast,
@@ -12,3 +13,16 @@ Espen Tangen,
 Giacomo Tartari,
 Steinar Traedal-Henden,
 UiT The Arctic University of Norway.
+
+## Locally building the HTML for testing
+
+```
+git clone https://github.com/uit-no/hpc-doc.git
+cd hpc-doc
+virtualenv venv           # optional step in case you need to install sphinx
+source venv/bin/activate  # optional step in case you need to install sphinx
+pip install sphinx        # optional step in case you need to install sphinx
+sphinx-build . _build
+```
+
+Then point your browser to `_build/index.html`.