aboutsummaryrefslogtreecommitdiff
path: root/doc/build
diff options
context:
space:
mode:
authorPaul Barker <paul.barker.ct@bp.renesas.com>2023-08-22 19:53:58 +0100
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2023-08-23 08:03:00 +0200
commit2a3c0680e60eea6591b6c43671d0eef4eac35681 (patch)
treef1c66c77c68edfbf642c939eac5ab952b0c80ec7 /doc/build
parentd737e9efcfc6c4afe207d82ae81bde57ba9f41a4 (diff)
downloadu-boot-2a3c0680e60eea6591b6c43671d0eef4eac35681.zip
u-boot-2a3c0680e60eea6591b6c43671d0eef4eac35681.tar.gz
u-boot-2a3c0680e60eea6591b6c43671d0eef4eac35681.tar.bz2
doc: Explicitly list build dependencies for docs
Highlight the packages which need to be installed in order to build the docs. Signed-off-by: Paul Barker <paul.barker.ct@bp.renesas.com>
Diffstat (limited to 'doc/build')
-rw-r--r--doc/build/documentation.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/build/documentation.rst b/doc/build/documentation.rst
index 011cd34..20b0fef 100644
--- a/doc/build/documentation.rst
+++ b/doc/build/documentation.rst
@@ -5,6 +5,17 @@ Building documentation
The U-Boot documentation is based on the Sphinx documentation generator.
+In addition to the Python packages listed in ``doc/sphinx/requirements.txt``,
+the following dependencies are needed to build the documentation:
+
+* fontconfig
+
+* graphviz
+
+* imagemagick
+
+* texinfo (if building the `Infodoc documentation`_)
+
HTML documentation
------------------