Skip to content

Commit 8519aed

Browse files
committed
update documentation on how to build documentation
1 parent 9b0aa89 commit 8519aed

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

doc/source/documentation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ which to include all the other pages.
2727
add its filename to the ``toctree`` in ``index.rst``
2828

2929
To build html documentation from it, you should first of all ``pip install
30-
Sphinx`` inside your virtualenv. Then you can run ``python setup.py
30+
'.[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
3131
build_sphinx``. This command will create documentation inside
3232
``build/sphinx/html/``. So run ``firefox build/sphinx/html/index.html`` and you
3333
can read it.

0 commit comments

Comments
 (0)