summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Opdenacker <michael@opdenacker.org>2024-06-11 14:50:26 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2024-06-16 22:48:18 +0100
commit5020a0f560bfdc9cbb2996a11f46366adda89cd1 (patch)
tree41ae2d36dd69887cdd8ab219ff08ed0a59f5c83f
parent9ece314372ae1392659f54cb3cc8425eb02586de (diff)
downloadpoky-5020a0f560bfdc9cbb2996a11f46366adda89cd1.tar.gz
documentation/README: refer to doc package requirements
Refer to package requirements for building documentation from supported distributions. The simple instructions previously listed no longer work on Ubuntu 24.04, for example. (From yocto-docs rev: c474f211a9a9ab9399627558b801d7546ebcd52b) Signed-off-by: Michael Opdenacker <michael@opdenacker.org> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/README29
1 files changed, 3 insertions, 26 deletions
diff --git a/documentation/README b/documentation/README
index b60472fcbf..c888b666a8 100644
--- a/documentation/README
+++ b/documentation/README
@@ -108,32 +108,9 @@ generated with DocBook.
108How to build the Yocto Project documentation 108How to build the Yocto Project documentation
109============================================ 109============================================
110 110
111Sphinx is written in Python. While it might work with Python2, for 111To build the documentation, you need Sphinx and a few other packages,
112obvious reasons, we will only support building the Yocto Project 112which depend on your host GNU/Linux distribution. Such packages are listed on
113documentation with Python3. 113https://docs.yoctoproject.org/dev/ref-manual/system-requirements.html#required-packages-for-the-build-host
114
115Sphinx might be available in your Linux distro packages repositories,
116however it is not recommended to use distro packages, as they might be
117old versions, especially if you are using an LTS version of your
118distro. The recommended method to install the latest versions of Sphinx
119and of its required dependencies is to use the Python Package Index (pip).
120
121To install all required packages run:
122
123 $ pip3 install sphinx sphinx_rtd_theme pyyaml
124
125To make sure you always have the latest versions of such packages, you
126should regularly run the same command with an added "--upgrade" option:
127
128 $ pip3 install --upgrade sphinx sphinx_rtd_theme pyyaml
129
130Also install the "inkscape" package from your distribution.
131Inkscape is need to convert SVG graphics to PNG (for EPUB
132export) and to PDF (for PDF export).
133
134Additionally install "fncychap.sty" TeX font if you want to build PDFs. Debian
135and Ubuntu have it in "texlive-latex-extra" package while RedHat distributions
136and OpenSUSE have it in "texlive-fncychap" package for example.
137 114
138To build the documentation locally, run: 115To build the documentation locally, run:
139 116