From: Mauro Carvalho Chehab <mchehab@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>,
Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
ksummit-discuss@lists.linuxfoundation.org
Subject: [PATCH v2 0/5] Address some issues with sphinx detection
Date: Sat, 2 Jul 2022 11:11:24 +0100 [thread overview]
Message-ID: <cover.1656756450.git.mchehab@kernel.org> (raw)
In-Reply-To: <CAHk-=wjYBONGGhiQu2iTP6zWu8y2a4=ii4byoomf6N77-pJNeA@mail.gmail.com>
Checking if Sphinx is available and read to run is tricky, and may involve
installing several packages for the document build to happen.
There are two options to install Sphinx:
- via distro-provided packages;
- via pip, using virtualenv/venv.
Some recent discussions showed a couple of misleading instructions.
This series improves the Sphinx detection by:
- Fixing the logich with checks if a past venv is working and recommend
just enabling it instead of installing a new venv;
- Detect if sphinx-build stopped working on a venv. This may happen during
distribution updates;
- Move the PDF minimal version to be later, in order for it to be printed only
after finishing the Sphinx version check;
Additionally, as now the Sphinx provided on almost all modern distros are
above the minimal required version, place instructions about how to install
Sphinx from the distro-provided packages after placing the instructions for
installing it via venv.
This will hopefully help to have more developers checking documentation
builds with
make htmldocs
---
v2:
- Fix some issues at the logic that was recommending installing via
distro-package manager;
- Add a notice about Sphinx 3.0+ false-positive warnings due to a
Sphinx bug. People using a version different than the recommended
one should know about that.
Mauro Carvalho Chehab (5):
scripts: sphinx-pre-install: fix venv version check logic
scripts: sphinx-pre-install: report broken venv
scripts: sphinx-pre-install: check for PDF min version later on
scripts: sphinx-pre-install: provide both venv and package installs
scripts: sphinx-pre-install: place a warning for Sphinx >= 3.0
scripts/sphinx-pre-install | 90 +++++++++++++++++++++++++++++---------
1 file changed, 69 insertions(+), 21 deletions(-)
--
2.36.1
next prev parent reply other threads:[~2022-07-02 10:11 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <CAHk-=wjYBONGGhiQu2iTP6zWu8y2a4=ii4byoomf6N77-pJNeA@mail.gmail.com>
2022-07-01 8:48 ` [PATCH 0/4] Address some issues with sphinx detection Mauro Carvalho Chehab
2022-07-01 8:48 ` [PATCH 1/4] scripts: sphinx-pre-install: fix venv version check logic Mauro Carvalho Chehab
2022-07-01 8:48 ` [PATCH 2/4] scripts: sphinx-pre-install: report broken venv Mauro Carvalho Chehab
2022-07-01 8:48 ` [PATCH 3/4] scripts: sphinx-pre-install: check for PDF min version later on Mauro Carvalho Chehab
2022-07-01 8:48 ` [PATCH 4/4] scripts: sphinx-pre-install: provide both venv and package installs Mauro Carvalho Chehab
2022-07-02 10:11 ` Mauro Carvalho Chehab [this message]
2022-07-02 10:11 ` [PATCH v2 1/5] scripts: sphinx-pre-install: fix venv version check logic Mauro Carvalho Chehab
2022-07-02 10:11 ` [PATCH v2 2/5] scripts: sphinx-pre-install: report broken venv Mauro Carvalho Chehab
2022-07-02 10:11 ` [PATCH v2 3/5] scripts: sphinx-pre-install: check for PDF min version later on Mauro Carvalho Chehab
2022-07-02 10:11 ` [PATCH v2 4/5] scripts: sphinx-pre-install: provide both venv and package installs Mauro Carvalho Chehab
2022-07-02 10:11 ` [PATCH v2 5/5] scripts: sphinx-pre-install: place a warning for Sphinx >= 3.0 Mauro Carvalho Chehab
2022-07-05 4:15 ` [PATCH v2 0/5] Address some issues with sphinx detection Akira Yokosawa
2022-07-06 14:31 ` Akira Yokosawa
2022-07-07 20:33 ` Mauro Carvalho Chehab
2022-07-07 18:45 ` Jonathan Corbet
2022-07-07 20:25 ` Mauro Carvalho Chehab
2022-07-07 20:15 ` Mauro Carvalho Chehab
2022-07-08 11:34 ` Expectation to --no-pdf option (was Re: [PATCH v2 0/5] Address some issues with sphinx detection) Akira Yokosawa
2022-07-08 14:02 ` Jonathan Corbet
2022-07-08 14:59 ` Mauro Carvalho Chehab
2022-07-08 15:27 ` Akira Yokosawa
2022-07-08 23:01 ` Akira Yokosawa
2022-07-09 7:59 ` Mauro Carvalho Chehab
2022-07-11 11:23 ` Akira Yokosawa
2022-08-01 23:30 ` [PATCH v2 0/5] Address some issues with sphinx detection Tomasz Warniełło
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=cover.1656756450.git.mchehab@kernel.org \
--to=mchehab@kernel.org \
--cc=corbet@lwn.net \
--cc=ksummit-discuss@lists.linuxfoundation.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+huawei@kernel.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;
as well as URLs for NNTP newsgroup(s).