michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: improve doc processor installation

Browse source 
A few language fixes to the "Installing the documentation
processors" section.
Also adding comments to be able to include this section in
other locations.

Signed-off-by: Ruth Fuchss <ruth.fuchss@nordicsemi.no>
This commit is contained in:
Ruth Fuchss 2021-05-27 16:44:06 +02:00 • committed by Kumar Gala
commit b07356dbce
1 changed files with 8 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

10
doc/README.rst
View file

@ -64,6 +64,8 @@ described in :ref:`getting_started`. Then install additional tools
that are only required to generate the documentation, that are only required to generate the documentation,
as described below: as described below:
.. doc_processors_installation_start
.. tabs:: .. tabs::
.. group-tab:: Linux .. group-tab:: Linux
@ -96,6 +98,8 @@ as described below:
.. group-tab:: macOS .. group-tab:: macOS
Use ``brew`` and ``tlmgr`` to install the tools:
.. code-block:: console .. code-block:: console
brew install doxygen mactex librsvg brew install doxygen mactex librsvg
@ -104,7 +108,7 @@ as described below:
.. group-tab:: Windows .. group-tab:: Windows
Run in an Administrator ``cmd.exe`` prompt: Open a ``cmd.exe`` window as **Administrator** and run the following command:
.. code-block:: console .. code-block:: console
@ -113,10 +117,12 @@ as described below:
.. note:: .. note::
On Windows, the Sphinx executable ``sphinx-build.exe`` is placed in On Windows, the Sphinx executable ``sphinx-build.exe`` is placed in
the ``Scripts`` folder of your Python installation path. the ``Scripts`` folder of your Python installation path.
Dependending on how you have installed Python, you may need to Dependending on how you have installed Python, you might need to
add this folder to your ``PATH`` environment variable. Follow add this folder to your ``PATH`` environment variable. Follow
the instructions in `Windows Python Path`_ to add those if needed. the instructions in `Windows Python Path`_ to add those if needed.
.. doc_processors_installation_end
Documentation presentation theme Documentation presentation theme
******************************** ********************************