Skip to content

Commit

Permalink
update documentation on how to build documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
boyska committed Aug 22, 2016
1 parent 25a575a commit 2e3656e
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/source/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 2e3656e

Please sign in to comment.