michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: readme: group requirements using one tab per platform

Browse source 
It is easier to follow the user guide if each platform has its own tab
for requirements.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
This commit is contained in:
Gerard Marull-Paretas 2021-03-04 11:20:53 +01:00 • committed by Anas Nashif
commit 1e1a3e3883
1 changed files with 34 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

32
doc/README.rst
View file

@ -67,47 +67,53 @@ 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:
On Ubuntu Linux: .. tabs::
.. code-block:: console .. group-tab:: Linux
On Ubuntu Linux:
.. code-block:: console
sudo apt-get install --no-install-recommends doxygen librsvg2-bin \ sudo apt-get install --no-install-recommends doxygen librsvg2-bin \
texlive-latex-base texlive-latex-extra latexmk texlive-fonts-recommended texlive-latex-base texlive-latex-extra latexmk texlive-fonts-recommended
On Fedora Linux: On Fedora Linux:
.. code-block:: console .. code-block:: console
sudo dnf install doxygen texlive-latex latexmk \ sudo dnf install doxygen texlive-latex latexmk \
texlive-collection-fontsrecommended librsvg2-tools texlive-collection-fontsrecommended librsvg2-tools
On Clear Linux: On Clear Linux:
.. code-block:: console .. code-block:: console
sudo swupd bundle-add texlive sudo swupd bundle-add texlive
On Arch Linux: On Arch Linux:
.. code-block:: console .. code-block:: console
sudo pacman -S doxygen librsvg texlive-core texlive-bin sudo pacman -S doxygen librsvg texlive-core texlive-bin
On macOS: .. group-tab:: macOS
.. code-block:: console .. code-block:: console
brew install doxygen mactex librsvg brew install doxygen mactex librsvg
tlmgr install latexmk tlmgr install latexmk
tlmgr install collection-fontsrecommended tlmgr install collection-fontsrecommended
On Windows in an Administrator ``cmd.exe`` prompt: .. group-tab:: Windows
.. code-block:: console Run in an Administrator ``cmd.exe`` prompt:
.. code-block:: console
choco install doxygen.install strawberryperl miktex rsvg-convert choco install doxygen.install strawberryperl miktex rsvg-convert
.. 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 may need to