diff options
author | Boyan Karatotev <boyan.karatotev@arm.com> | 2022-10-27 13:55:12 +0100 |
---|---|---|
committer | Boyan Karatotev <boyan.karatotev@arm.com> | 2022-11-16 14:06:48 +0000 |
commit | 8526472a46886f0a50c099ef17a1bf8add69ac06 (patch) | |
tree | ad01c7f1f7990f65b705a6de61923d163e21c42a /docs | |
parent | e48b1f8c48685068e98d2e8a431c4afc9749e20e (diff) | |
download | arm-trusted-firmware-8526472a46886f0a50c099ef17a1bf8add69ac06.tar.gz |
docs(build): clarify docs building instructions
Using virtual environments with pip is a generally recommended good
practice but the docs do not acknowledge it. As a result fresh installs
might fail builds due to missing $PATH entries. The Prerequisites
section is also a bit verbose which is difficult to read.
This patch adds the virtual environment mention and clarifies wording.
Signed-off-by: Boyan Karatotev <boyan.karatotev@arm.com>
Change-Id: Iea447fb59dc471a502454650c8548192d93ba879
Diffstat (limited to 'docs')
-rw-r--r-- | docs/getting_started/docs-build.rst | 31 |
1 files changed, 14 insertions, 17 deletions
diff --git a/docs/getting_started/docs-build.rst b/docs/getting_started/docs-build.rst index 87c677fcd..64c222e5e 100644 --- a/docs/getting_started/docs-build.rst +++ b/docs/getting_started/docs-build.rst @@ -17,19 +17,25 @@ check that you have the required software packages, as described in the Prerequisites ------------- -For building a local copy of the |TF-A| documentation you will need, at minimum: +For building a local copy of the |TF-A| documentation you will need: - Python 3 (3.5 or later) - PlantUML (1.2017.15 or later) +- Python modules specified in ``docs/requirements.txt`` -Optionally, the `Dia`_ application can be installed if you need to edit -existing ``.dia`` diagram files, or create new ones. + You can install these with ``pip3`` (the Python Package Installer) by + passing it the requirements file above (with ``-r``). An optional ``--user`` + argument will install them locally, but you have to add their location to + $PATH (pip will emit a warning). Alternatively, they can be installed + globally (but will probably require root privileges). -You must also install the Python modules that are specified in the -``requirements.txt`` file in the root of the ``docs`` directory. These modules -can be installed using ``pip3`` (the Python Package Installer). Passing this -requirements file as an argument to ``pip3`` automatically installs the specific -module versions required by |TF-A|. + .. note:: + Although not necessary, it is recommended you use a virtual environment. + More advanced usage instructions for *pip* are beyond the scope of this + document but you can refer to the `pip homepage`_ for detailed guides. + +- Optionally, the `Dia`_ application can be installed if you need to edit + existing ``.dia`` diagram files, or create new ones. An example set of installation commands for Ubuntu 18.04 LTS follows, assuming that the working directory is ``docs``: @@ -44,15 +50,6 @@ that the working directory is ``docs``: the list to ensure that there will be no conflicts with other modules already installed in your environment. -Passing the optional ``--user`` argument to ``pip3`` will install the Python -packages only for the current user. Omitting this argument will attempt to -install the packages globally and this will likely require the command to be run -as root or using ``sudo``. - -.. note:: - More advanced usage instructions for *pip* are beyond the scope of this - document but you can refer to the `pip homepage`_ for detailed guides. - Building rendered documentation ------------------------------- |