From b07356dbce208ca273654a9fc0fecd43411a4726 Mon Sep 17 00:00:00 2001 From: Ruth Fuchss Date: Thu, 27 May 2021 16:44:06 +0200 Subject: [PATCH] doc: improve doc processor installation 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 --- doc/README.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/doc/README.rst b/doc/README.rst index 62c22d5e46d..45cdfa1faf0 100644 --- a/doc/README.rst +++ b/doc/README.rst @@ -64,6 +64,8 @@ described in :ref:`getting_started`. Then install additional tools that are only required to generate the documentation, as described below: +.. doc_processors_installation_start + .. tabs:: .. group-tab:: Linux @@ -96,6 +98,8 @@ as described below: .. group-tab:: macOS + Use ``brew`` and ``tlmgr`` to install the tools: + .. code-block:: console brew install doxygen mactex librsvg @@ -104,7 +108,7 @@ as described below: .. 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 @@ -113,10 +117,12 @@ as described below: .. note:: On Windows, the Sphinx executable ``sphinx-build.exe`` is placed in 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 the instructions in `Windows Python Path`_ to add those if needed. +.. doc_processors_installation_end + Documentation presentation theme ********************************