Lines Matching +full:build +full:- +full:root +full:- +full:directory

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
15    copy without doing a local build.
18 -------------
20 For building a local copy of the |TF-A| documentation you will need, at minimum:
22 - Python 3 (3.5 or later)
23 - PlantUML (1.2017.15 or later)
29 ``requirements.txt`` file in the root of the ``docs`` directory. These modules
32 module versions required by |TF-A|.
35 that the working directory is ``docs``:
39     sudo apt install python3 python3-pip plantuml [dia]
40     pip3 install [--user] -r requirements.txt
47 Passing the optional ``--user`` argument to ``pip3`` will install the Python
50 as root or using ``sudo``.
57 -------------------------------
59 Documents can be built into HTML-formatted pages from project root directory by
66 Output from the build process will be placed in:
70    docs/build/html
73 directory of the project, run the following command to see the supported
75 the command is run from the project root directory, as that would invoke the
76 top-level Makefile for |TF-A| itself.
83 ------------------------------------------------
90 from project root directory
94    docker run --rm -v $PWD:/TF sphinxdoc/sphinx \
95           bash -c 'cd /TF && \
96           pip3 install plantuml -r ./docs/requirements.txt && make doc'
101 build process will be placed in:
105    docs/build/html
107 --------------
111 .. _Sphinx: http://www.sphinx-doc.org/en/master/