README.md: some documentation on how to build the docs

2017-11-11 23:32:21 +01:00
parent ae4b12c9ba
commit 000c8b4186
1 changed files with 9 additions and 0 deletions
@@ -68,3 +68,12 @@ variables and types are often named *dataset* when they in fact refer to a *file
 There will not be a big refactoring (an attempt was made, but it's destroying too much history without much gain).

 However, new contributions & patches should fix naming without further notice in the commit message.
+
+### Building `docs`
+
+```
+cd docs
+pip install sphinx sphinx-rtd-theme
+make clean html
+xdg-open _build/html/index.html
+```