Address some issues with sphinx detection
Get series with b4
b4 am [email protected]Versions newest first · linked by author and title
- v2 Latest5 patches 14 repliesIn review
- v14 patches 0 repliesSuperseded
Changes in v2 from the cover letter
- 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.
Patches in v2 No applies recorded yet
| # | Subject and files | Size | Replies | Applied |
|---|---|---|---|---|
| 1/5 | scripts: sphinx-pre-install: fix venv version check logicscripts/ | +7 | 0 replies | |
| 2/5 | scripts: sphinx-pre-install: report broken venvscripts/ | +6 | 0 replies | |
| 3/5 | scripts: sphinx-pre-install: check for PDF min version later onscripts/ | +10 | 0 replies | |
| 4/5 | scripts: sphinx-pre-install: provide both venv and package installsscripts/ | +42 | 0 replies | |
| 5/5 | scripts: sphinx-pre-install: place a warning for Sphinx >= 3.0scripts/ | +4 | 0 replies |
Reviews trailers per patch
No Reviewed-by, Acked-by or Tested-by trailers for v2 yet.
Cover letter [PATCH v2 0/5] Address some issues with sphinx detection
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(-)
Signature · 1 line
2.36.1