Lines Matching +full:make +full:- +full:docs
5 `Sphinx`_ tool to build and package the plain-text documents into HTML-formatted
14 https://www.trustedfirmware.org/docs/tf-a, if you want to view a rendered
18 -------------
20 For building a local copy of the |TF-A| documentation you will need:
22 - Python 3 (3.8 or later)
23 - PlantUML (1.2017.15 or later)
24 - `Poetry`_ (Python dependency manager)
25 - Optionally, the `Dia`_ application can be installed if you need to edit
34 sudo apt install python3 python3-pip plantuml [dia]
35 curl -sSL https://install.python-poetry.org | python3 -
38 -------------------------------
58 HTML-formatted pages from the project root directory by running:
62 poetry run make doc
64 Output from the build process will be placed in: ``docs/build/html``.
69 We also support building documentation in other formats. From the ``docs``
75 poetry run make -C docs help
80 - FreeSerif font
81 - latexmk
82 - librsvg2-bin
83 - xelatex
84 - xindy
91 sudo apt install fonts-freefont-otf latexmk librsvg2-bin texlive-xetex xindy
93 Once all the dependencies are installed, run the command ``poetry run make -C
94 docs latexpdf`` to build the documentation. Output from the build process
95 (``trustedfirmware-a.pdf``) can be found in ``docs/build/latex``.
105 the same virtual environment. This creates a sub-shell through which you can
106 build the documentation directly with ``make``.
111 make doc
117 ------------------------------------------------
128 docker run --rm -v $PWD:/tf-a sphinxdoc/sphinx \
129 bash -c 'cd /tf-a &&
130 apt-get update && apt-get install -y curl plantuml &&
131 curl -sSL https://install.python-poetry.org | python3 - &&
132 ~/.local/bin/poetry install && ~/.local/bin/poetry run make doc'
137 build process will be placed in: ``docs/build/html``.
139 --------------
141 *Copyright (c) 2019-2023, Arm Limited. All rights reserved.*
143 .. _Sphinx: http://www.sphinx-doc.org/en/master/
144 .. _Poetry: https://python-poetry.org/docs/