Skip to content

Commit

Permalink
[Docs] Update building requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
donporter authored and mkow committed Oct 5, 2020
1 parent f68e61a commit 98b97c9
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
13 changes: 8 additions & 5 deletions Documentation/devel/howto-doc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,18 +41,21 @@ not published.
Building documentation
----------------------

To build documentation, change directory to ``Documentation``, install
prerequisites, and use ``make``, specifying the appropriate target. The output
is in the ``_build`` directory:
To build documentation, change directory to ``Documentation``, install prerequisites, and use
``make``, specifying the appropriate target. The documentation is built with python3; if you have
similar packages in python2, it may create problems; we recommend removing any similar packages in
python2. Similarly, the documentation requires version 1.8 of sphinx.

The output is in the ``_build`` directory:

.. code-block:: sh
# change directory to Documentation
cd Documentation
# install prerequisites (use pip3 for Python3)
# install prerequisites
sudo apt-get install doxygen
pip install -r requirements.txt
python3 -m pip install -r requirements.txt
# build targets "html" and "man"
make html man
Expand Down
1 change: 1 addition & 0 deletions Documentation/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
sphinx==1.8.0
breathe<4.13.0
recommonmark
sphinx_rtd_theme

0 comments on commit 98b97c9

Please sign in to comment.