[PATCH v2 0/5] docs: sphinx-pre-install: improve dependency checks

Chen Miao posted 5 patches 1 month, 2 weeks ago
There is a newer version of this series
Documentation/doc-guide/sphinx.rst            |  20 +++
.../translations/zh_CN/doc-guide/sphinx.rst   |  17 +-
Documentation/translations/zh_CN/how-to.rst   |   8 +
tools/docs/sphinx-build-wrapper               |  55 ++++++-
tools/docs/sphinx-pre-install                 | 154 +++++++++++++++++-
5 files changed, 244 insertions(+), 10 deletions(-)
[PATCH v2 0/5] docs: sphinx-pre-install: improve dependency checks
Posted by Chen Miao 1 month, 2 weeks ago
Hi all,

The Sphinx dependency checker currently does not provide useful
installation guidance on macOS and only checks whether a make executable
exists. This can leave macOS users without a clear setup path and allow an
incompatible make implementation to pass the dependency check before the
documentation build fails.

This series:

- documents the case-sensitive APFS volume needed for a kernel tree on
  macOS;
- adds macOS/Homebrew dependency handling, including command-line-only
  MacTeX support, required PDF font casks, and a PATH refresh hint;
- checks for GNU Make 4.0 or newer and honors an exported MAKE before
  preferring Homebrew gmake;
- teaches sphinx-build-wrapper to select a compatible GNU Make lazily for
  Info and Rust docs; and
- updates the zh_CN documentation in separate patches, including the APFS
  guidance in the contributor how-to.

Changes in v2:

- do not treat Homebrew itself as a mandatory build dependency;
- use the mactex-no-gui cask, install the required DejaVu and Noto CJK
  font casks, and document the post-install PATH refresh;
- honor MAKE consistently in the dependency checker and build wrapper;
- prefer a compatible gmake before falling back to make;
- resolve GNU Make only for targets that invoke it;
- add a separate patch for tools/docs/sphinx-build-wrapper;
- split the English changes and zh_CN translations into separate patches;
  and
- document diskutil apfs addVolume diskX APFSX Linux in the English guide,
  its zh_CN translation, and the zh_CN contributor how-to.

Link: https://lore.kernel.org/linux-doc/20260809101923.13176-1-chenmiao.ku@gmail.com/

Thanks,
Chen Miao

Chen Miao (5):
  docs: sphinx-pre-install: add macOS Homebrew support
  docs: sphinx-pre-install: check GNU Make version
  docs: sphinx-build-wrapper: prefer gmake
  docs/zh_CN: doc-guide: document macOS Sphinx setup
  docs/zh_CN: how-to: document case-sensitive APFS setup

 Documentation/doc-guide/sphinx.rst            |  20 +++
 .../translations/zh_CN/doc-guide/sphinx.rst   |  17 +-
 Documentation/translations/zh_CN/how-to.rst   |   8 +
 tools/docs/sphinx-build-wrapper               |  55 ++++++-
 tools/docs/sphinx-pre-install                 | 154 +++++++++++++++++-
 5 files changed, 244 insertions(+), 10 deletions(-)


base-commit: 8492d4e6bb7b9b1e78f2d17c4dda5272f25ec118
-- 
2.50.1 (Apple Git-155)