Skip to content

Commit 7d44d24

Browse files
Arnfinnrobertodr
authored andcommitted
Replace "warning" with "note" in documentation
- `requirement.txt` has been moved earlier. The doc now reflects that - Added to note that we also have a Pipfile.
1 parent 3ce437c commit 7d44d24

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

doc/programmers/documentation.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,10 @@ To have an offline version of the documentation just issue
6060
Open the ``_build/index.html`` file with your browser to see and browse the
6161
documentation.
6262

63-
.. warning::
63+
.. note::
6464

6565
Building the documentation requires Python, Doxygen, Sphinx, Perl and the
6666
Python modules pyyaml, breathe, matplotlib, sphinx-rtd-theme,
67-
sphinxcontrib-bibtex and recommonmark.
68-
69-
The required python modules can be installed by running ``pip install -r doc/requirements.txt``.
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``.

0 commit comments

Comments
 (0)