Djam/arm-trusted-firmware
1
0
Fork 0
mirror of https://github.com/ARM-software/arm-trusted-firmware.git synced 2025-04-16 01:24:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs(prerequisites): add Poetry installation instructions

Browse source 
This small change removes the footnote from Poetry that it is only used
for building documentation, as it is now used for some of the Python
tooling in the repository from the build system.

Additionally, add a link to the official installation guide for Poetry.

Change-Id: Ie36b7ecd8066cbf2a14a1085d84fa9bd9c4409ba
Signed-off-by: Chris Kay <chris.kay@arm.com>
This commit is contained in:
Chris Kay 2024-11-13 15:32:10 +00:00
parent dc5d485206
commit 0c9cd67d56
1 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/getting_started/prerequisites.rst
View file

@ -34,7 +34,7 @@ GNU make 3.81
mbed TLS\ [#f1]_ 3.6.1
Node.js [#f2]_ 16
OpenSSL 1.0.0
Poetry [#f2]_ 1.3.2
Poetry 1.3.2
QCBOR\ [#f3]_ 1.2
Sphinx\ [#f2]_ 2.4.4
======================== =====================
@ -103,9 +103,11 @@ Poetry
^^^^^^
Required for managing Python dependencies, this will allow you to reliably
reproduce a Python environment to build documentation and run analysis tools.
Most importantly, it ensures your system environment will not be affected by
dependencies in the Python scripts.
reproduce a Python environment to build documentation and run some of the
integrated Python tools. Most importantly, it ensures your system environment
will not be affected by dependencies in the Python scripts.
For installation instructions, see the `official Poetry documentation`_.
.. _prerequisites_software_and_libraries:
@ -191,3 +193,4 @@ documentation, available `here <https://git-scm.com/docs/githooks>`_.
.. _Arm-DS: https://developer.arm.com/Tools%20and%20Software/Arm%20Development%20Studio
.. _Linaro Release 20.01: http://releases.linaro.org/members/arm/platforms/20.01
.. _TrustedFirmware.org: https://www.trustedfirmware.org/
.. _official Poetry documentation: https://python-poetry.org/docs/#installation