Merge "README: Update how to generate the docs"
This commit is contained in:
commit
1fa431fdbe
|
@ -42,12 +42,8 @@ The source is maintained in the ``doc/source`` directory using
|
||||||
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
|
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
|
||||||
.. _Sphinx: http://sphinx-doc.org/
|
.. _Sphinx: http://sphinx-doc.org/
|
||||||
|
|
||||||
* Building Automatically::
|
To build the docs, use::
|
||||||
|
|
||||||
$ ./run_tests.sh --docs
|
$ tox -e docs
|
||||||
|
|
||||||
* Building Manually::
|
|
||||||
|
|
||||||
$ tools/with_venv.sh sphinx-build doc/source doc/build/html
|
|
||||||
|
|
||||||
Results are in the ``doc/build/html`` directory
|
Results are in the ``doc/build/html`` directory
|
||||||
|
|
Loading…
Reference in New Issue