github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-08-08 03:35:14 +00:00
Code Issues Projects Releases Wiki Activity

doc: update doc build instructions

Browse Source 
New versions of doc build tools are listed, along with tweaks to the
requirements.txt and list of tools installed with apt for building
documentation.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2021-01-19 17:58:52 -08:00 committed by David Kinder
parent 329296f095
commit 2f7e0cde46
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
doc/tutorials/docbuild.rst
View File

@ -124,22 +124,21 @@ Installing the documentation tools
Our documentation processing has been tested to run with Python 3.6.3 Our documentation processing has been tested to run with Python 3.6.3
and these other tools: and these other tools:
* breathe version: 4.9.1 * breathe version: 4.23.0
* sphinx version: 1.7.7 * sphinx version: 3.2.1
* docutils version: 0.14 * docutils version: 0.16
* sphinx-rtd-theme version: 0.4.0 * sphinx-rtd-theme version: 0.5.0
* kconfiglib version: 10.9.1 * kconfiglib version: 14.1.0
* sphinx-tabs version: 1.1.13 * sphinx-tabs version: 1.3.0
* doxygen version: 1.8.13 * doxygen version: 1.8.13
Depending on your Linux version, install the needed tools: Depending on your Linux version, install the needed tools.
For Ubuntu use:
* For Ubuntu use:
.. code-block:: bash .. code-block:: bash
sudo apt-get install doxygen python3-pip \ sudo apt-get install doxygen python3-pip \
python3-wheel make graphviz python3-wheel make graphviz xsltproc
Then use ``pip3`` to install the remaining Python-based tools: Then use ``pip3`` to install the remaining Python-based tools:
@ -149,7 +148,7 @@ Then use ``pip3`` to install the remaining Python-based tools:
pip3 install --user -r scripts/requirements.txt pip3 install --user -r scripts/requirements.txt
Add ``$HOME/.local/bin`` to the front of your ``PATH`` so the system will Add ``$HOME/.local/bin`` to the front of your ``PATH`` so the system will
find expected versions of Python utilities such as ``sphinx-build`` and find expected versions of these Python utilities such as ``sphinx-build`` and
``breathe``: ``breathe``:
.. code-block:: bash .. code-block:: bash
@ -166,7 +165,8 @@ And with that you're ready to generate the documentation.
.. note:: .. note::
We've provided a script you can run to show what versions of the We've provided a script you can run to show what versions of the
documentation building tools are installed.:: documentation building tools are installed and compare with the
tool versions shown above.::
doc/scripts/show-versions.py doc/scripts/show-versions.py