From 000c8b4186582d9672c54aa92976d6a9f80808e9 Mon Sep 17 00:00:00 2001 From: Christian Schwarz Date: Sat, 11 Nov 2017 23:32:21 +0100 Subject: [PATCH] README.md: some documentation on how to build the docs --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 8ac18ac..030db1e 100644 --- a/README.md +++ b/README.md @@ -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 +```