From 5020a0f560bfdc9cbb2996a11f46366adda89cd1 Mon Sep 17 00:00:00 2001 From: Michael Opdenacker Date: Tue, 11 Jun 2024 14:50:26 +0200 Subject: 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 Reviewed-by: Quentin Schulz Signed-off-by: Alexandre Belloni Signed-off-by: Richard Purdie --- documentation/README | 29 +++-------------------------- 1 file changed, 3 insertions(+), 26 deletions(-) (limited to 'documentation/README') 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. How to build the Yocto Project documentation ============================================ -Sphinx is written in Python. While it might work with Python2, for -obvious reasons, we will only support building the Yocto Project -documentation with Python3. - -Sphinx might be available in your Linux distro packages repositories, -however it is not recommended to use distro packages, as they might be -old versions, especially if you are using an LTS version of your -distro. The recommended method to install the latest versions of Sphinx -and of its required dependencies is to use the Python Package Index (pip). - -To install all required packages run: - - $ pip3 install sphinx sphinx_rtd_theme pyyaml - -To make sure you always have the latest versions of such packages, you -should regularly run the same command with an added "--upgrade" option: - - $ pip3 install --upgrade sphinx sphinx_rtd_theme pyyaml - -Also install the "inkscape" package from your distribution. -Inkscape is need to convert SVG graphics to PNG (for EPUB -export) and to PDF (for PDF export). - -Additionally install "fncychap.sty" TeX font if you want to build PDFs. Debian -and Ubuntu have it in "texlive-latex-extra" package while RedHat distributions -and OpenSUSE have it in "texlive-fncychap" package for example. +To build the documentation, you need Sphinx and a few other packages, +which depend on your host GNU/Linux distribution. Such packages are listed on +https://docs.yoctoproject.org/dev/ref-manual/system-requirements.html#required-packages-for-the-build-host To build the documentation locally, run: -- cgit v1.2.3-54-g00ecf