Skip to content

Improvements to the documentation build system

Mauro Carvalho Chehab linux-doc lkml 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest5 patches 6 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/5scripts/sphinx-pre-install: make activate hint smarterscripts/sphinx-pre-install+14 -80 replies
2/5scripts/sphinx-pre-install: get rid of RHEL7 explicity checkscripts/sphinx-pre-install+0 -130 replies
3/5scripts/sphinx-pre-install: always check if version is compatible with buildDocumentation/Makefile scripts/sphinx-pre-install+35 -160 replies
4/5docs: by default, build docs a lot faster with Sphinx >= 1.7Documentation/Makefile+2 -06 replies
5/5docs: requirements.txt: recommend Sphinx 1.7.9Documentation/doc-guide/sphinx.rst Documentation/sphinx/requirements.txt+10 -110 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 0/5] Improvements to the documentation build system

The first three patches here address some issues with the script which detects the requirements for running Sphinx, making it a smarter and running it all the times, in order to allow recommending version updates.

The 4th patch adds "-jauto" by default, if Sphinx version supports it (e. g. version 1.7 or upper).

The final patch changes the recommendation to use at least Sphinx version 1.7.9, as discussed at linux-doc ML.

Mauro Carvalho Chehab (5):
scripts/sphinx-pre-install: make activate hint smarter scripts/sphinx-pre-install: get rid of RHEL7 explicity check scripts/sphinx-pre-install: always check if version is compatible with
build
docs: by default, build docs a lot faster with Sphinx >= 1.7
docs: requirements.txt: recommend Sphinx 1.7.9

 Documentation/Makefile                |  7 +++
 Documentation/doc-guide/sphinx.rst    | 17 +++---
 Documentation/sphinx/requirements.txt |  4 +-
 scripts/sphinx-pre-install            | 75 +++++++++++++++------------
 4 files changed, 58 insertions(+), 45 deletions(-)
Signature · 1 line
2.21.0