public inbox for docs@lists.yoctoproject.org
 help / color / mirror / Atom feed
From: michael@opdenacker.org
To: docs@lists.yoctoproject.org
Cc: Michael Opdenacker <michael@opdenacker.org>
Subject: [PATCH] documentation/README: refer to doc package requirements
Date: Tue, 11 Jun 2024 14:50:26 +0200	[thread overview]
Message-ID: <20240611125026.22702-1-michael@opdenacker.org> (raw)

From: Michael Opdenacker <michael@opdenacker.org>

Refer to package requirements for building documentation
from supported distributions. The simple instructions
previously listed no longer work on Ubuntu 24.04, for example.

Signed-off-by: Michael Opdenacker <michael@opdenacker.org>
---
 documentation/README | 29 +++--------------------------
 1 file 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.
 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:
 


             reply	other threads:[~2024-06-11 12:50 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-06-11 12:50 michael [this message]
2024-06-13  8:37 ` [docs] [PATCH] documentation/README: refer to doc package requirements Quentin Schulz
2024-06-18 14:52   ` Michael Opdenacker
2024-06-19 11:42     ` Quentin Schulz

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240611125026.22702-1-michael@opdenacker.org \
    --to=michael@opdenacker.org \
    --cc=docs@lists.yoctoproject.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox