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

Merge changes I0448caa4,I8ee666ee into integration

Browse source 
* changes:
  build: install dependencies before doc build
  fix(docs): fix the example command for doc build
This commit is contained in:
Manish V Badarkhe 2024-11-06 17:01:51 +01:00 • committed by TrustedFirmware Code Review
commit 9bc738d209
2 changed files with 5 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
docs/Makefile
View file

@ -24,4 +24,5 @@ help:
# Catch-all target: route all unknown targets to Sphinx using the new # Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
.DEFAULT: Makefile .DEFAULT: Makefile
$(if $(host-poetry),$(q)poetry -q install --with=docs)
$(q)$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) $(q)$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

25
docs/getting_started/docs-build.rst
View file

@ -37,25 +37,8 @@ Ubuntu):
Building rendered documentation Building rendered documentation
------------------------------- -------------------------------
To install Python dependencies using Poetry: The documentation can be compiled into HTML-formatted pages from the project
root directory by running:
.. code:: shell
poetry install
Poetry will create a new virtual environment and install all dependencies listed
in ``pyproject.toml``. You can get information about this environment, such as
its location and the Python version, with the command:
.. code:: shell
poetry env info
If you have already sourced a virtual environment, Poetry will respect this and
install dependencies there.
Once all dependencies are installed, the documentation can be compiled into
HTML-formatted pages from the project root directory by running:
.. code:: shell .. code:: shell
@ -129,7 +112,7 @@ from project root directory
bash -c 'cd /tf-a && bash -c 'cd /tf-a &&
apt-get update && apt-get install -y curl plantuml && apt-get update && apt-get install -y curl plantuml &&
curl -sSL https://install.python-poetry.org | python3 - && curl -sSL https://install.python-poetry.org | python3 - &&
~/.local/bin/poetry install && ~/.local/bin/poetry run make doc' ~/.local/bin/poetry run make doc'
The above command fetches the ``sphinxdoc/sphinx`` container from `docker The above command fetches the ``sphinxdoc/sphinx`` container from `docker
hub`_, launches the container, installs documentation requirements and finally hub`_, launches the container, installs documentation requirements and finally
@ -138,7 +121,7 @@ build process will be placed in: ``docs/build/html``.
-------------- --------------
*Copyright (c) 2019-2023, Arm Limited. All rights reserved.* *Copyright (c) 2019-2024, Arm Limited. All rights reserved.*
.. _Sphinx: http://www.sphinx-doc.org/en/master/ .. _Sphinx: http://www.sphinx-doc.org/en/master/
.. _Poetry: https://python-poetry.org/docs/ .. _Poetry: https://python-poetry.org/docs/