From 8519aedd335dff3c7c9d0883a12bd6ea7c8d95aa Mon Sep 17 00:00:00 2001 From: boyska Date: Tue, 2 Aug 2016 09:34:26 +0200 Subject: [PATCH] update documentation on how to build documentation --- doc/source/documentation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/documentation.rst b/doc/source/documentation.rst index e3d096e..093c1fb 100644 --- a/doc/source/documentation.rst +++ b/doc/source/documentation.rst @@ -27,7 +27,7 @@ which to include all the other pages. add its filename to the ``toctree`` in ``index.rst`` To build html documentation from it, you should first of all ``pip install -Sphinx`` inside your virtualenv. Then you can run ``python setup.py +'.[doc]'`` inside your virtualenv. If this command fails, you probably have an old pip version: run ``pip install -U pip`` to fix this. Then you can run ``python setup.py build_sphinx``. This command will create documentation inside ``build/sphinx/html/``. So run ``firefox build/sphinx/html/index.html`` and you can read it.