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 Latest10 patches 2 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/10docs: cdomain.py: get rid of a warning since version 1.8Documentation/sphinx/cdomain.py+4 -10 replies
2/10scripts/sphinx-pre-install: make activate hint smarterscripts/sphinx-pre-install+14 -80 replies
3/10scripts/sphinx-pre-install: get rid of RHEL7 explicity checkscripts/sphinx-pre-install+0 -130 replies
4/10scripts/sphinx-pre-install: always check if version is compatible with buildDocumentation/Makefile scripts/sphinx-pre-install+35 -160 replies
5/10scripts/documentation-file-ref-check: better handle translationsscripts/documentation-file-ref-check+7 -30 replies
6/10scripts/documentation-file-ref-check: exclude false-positivesscripts/documentation-file-ref-check+13 -00 replies
7/10scripts/documentation-file-ref-check: improve tools ref handlingscripts/documentation-file-ref-check+1 -10 replies
8/10scripts/documentation-file-ref-check: teach about .txt -> .yaml renamesscripts/documentation-file-ref-check+14 -50 replies
9/10docs: by default, build docs a lot faster with Sphinx >= 1.7Documentation/Makefile+2 -01 reply
10/10docs: 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 00/10] Improvements to the documentation build system

Hi Jon,

This series contain some improvements for the building system.

I sent already several of the patches here. They're rebased on the top of your docs-next tree:

patch 1: gets rid of a warning since version 1.8 (I guess it starts appearing with 1.8.6);

patches 2 to 4: improve the pre-install script;

patches 5 to 8: improve the script with checks broken doc references;

patch 9: by default, use "-jauto" with Sphinx 1.7 or upper, in order to speed up the build.

patch 10 changes the recommended Sphinx version to 1.7.9. It keeps the minimal supported version to 1.3.

Patch 4 contains a good description of the improvements made at the build system.

If you prefer, you can pull those patches (and the next series I'm submitting you) from my development git tree:

https://git.linuxtv.org/mchehab/experimental.git/log/?h=fix_doc_links_v2

Regards,
Mauro

-

Mauro Carvalho Chehab (10):
docs: cdomain.py: get rid of a warning since version 1.8 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
scripts/documentation-file-ref-check: better handle translations scripts/documentation-file-ref-check: exclude false-positives scripts/documentation-file-ref-check: improve tools ref handling scripts/documentation-file-ref-check: teach about .txt -> .yaml
renames
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/cdomain.py       |  5 +-
 Documentation/sphinx/requirements.txt |  4 +-
 scripts/documentation-file-ref-check  | 44 ++++++++++++----
 scripts/sphinx-pre-install            | 75 +++++++++++++++------------
 6 files changed, 97 insertions(+), 55 deletions(-)
Signature · 1 line
2.21.0