From 5ac3fdcdfbed4a017fd8c94af81f6d2a79460287 Mon Sep 17 00:00:00 2001 From: Elizabeth Ho Date: Wed, 9 Aug 2023 16:03:21 +0100 Subject: [PATCH] docs: add instructions for PDF generation of docs 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 --- docs/getting_started/docs-build.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/getting_started/docs-build.rst b/docs/getting_started/docs-build.rst index aa8c2bbf6..50fff5756 100644 --- a/docs/getting_started/docs-build.rst +++ b/docs/getting_started/docs-build.rst @@ -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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~