Skip to content

Commit 1c3da69

Browse files
committed
Update documentation on building docs
1 parent e01c1b1 commit 1c3da69

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

doc/programmers/documentation.rst

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -56,14 +56,26 @@ How does this work?
5656
-------------------
5757

5858
To have an offline version of the documentation just issue
59-
``sphinx-build doc/ _build/.``. The HTML will be stored in ``_build/``.
60-
Open the ``_build/index.html`` file with your browser to see and browse the
61-
documentation.
59+
in the ``doc`` folder:
60+
61+
.. code-block:: bash
62+
sphinx-build . _build
63+
64+
The HTML will be stored in ``_build/``. Open the ``_build/index.html`` file with
65+
your browser to see and browse the documentation.
66+
67+
.. warning::
68+
It is only possible to build documentation locally from within the ``doc``
69+
folder.
70+
This choice was made to simplify the set up of the ReadTheDocs and local
71+
documentation building procedures and to minimize the chances of breaking
72+
either.
6273

6374
.. note::
6475

6576
Building the documentation requires Python, Doxygen, Sphinx, Perl and the
66-
Python modules pyyaml, breathe, matplotlib, sphinx-rtd-theme,
67-
sphinxcontrib-bibtex and recommonmark. The required python modules can be
68-
installed by running ``pip install -r requirements.txt``. There is also a
69-
``Pipfile`` in case people prefer to use ``pipenv``.
77+
Python modules breathe, matplotlib, sphinx-rtd-theme, sphinxcontrib-bibtex
78+
and recommonmark.
79+
The required python modules can be installed by running ``pip install -r
80+
requirements.txt``.
81+
There is also a ``Pipfile`` in case people prefer to use ``pipenv``.

0 commit comments

Comments
 (0)