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

docs: add instructions for PDF generation of docs

Browse source 
This patch details the required packages and terminal commands for
building the documentation in PDF format locally.

Change-Id: Ic5f416b73e46d5f362fe9eb909200b95eda19e6a
Signed-off-by: Elizabeth Ho <elizabeth.ho@arm.com>
This commit is contained in:
Elizabeth Ho 2023-08-09 16:03:21 +01:00
parent 2360d18bb5
commit 5ac3fdcdfb
1 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -74,6 +74,26 @@ formats.
poetry run make -C docs help
To build the documentation in PDF format, additionally ensure that the following
packages are installed:
- FreeSerif font
- latexmk
- librsvg2-bin
- xelatex
- xindy
Below is an example set of instructions to install the required packages
(tested on Ubuntu):
.. code:: shell
sudo apt install fonts-freefont-otf latexmk librsvg2-bin texlive-xetex xindy
Once all the dependencies are installed, run the command ``poetry run make -C
docs latexpdf`` to build the documentation. Output from the build process
(``trustedfirmware-a.pdf``) can be found in ``docs/build/latex``.
Building rendered documentation from Poetry's virtual environment
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~