[v1] docs: sphinx-pre-install: improve dependency checks

[PATCH v1 0/2] docs: sphinx-pre-install: improve dependency checks

Chen Miao posted 2 patches 1 month, 2 weeks ago

Diff against v2 v3 v4
Download series mbox

There is a newer version of this series

Documentation/doc-guide/sphinx.rst            |   9 ++
.../translations/zh_CN/doc-guide/sphinx.rst   |   7 +
Documentation/translations/zh_CN/how-to.rst   |   7 +
tools/docs/sphinx-pre-install                 | 141 +++++++++++++++++-
4 files changed, 162 insertions(+), 2 deletions(-)

Expand all Fold all

[PATCH v1 0/2] 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:

  - adds macOS/Homebrew dependency handling, including MacTeX cask support;
  - checks for GNU Make 4.0 or newer and recognizes Homebrew's ``gmake``; and
  - avoids printing an empty installation command when only PyYAML is missing.

Thanks,

Chen Miao

Chen Miao (2):
  docs: sphinx-pre-install: add macOS Homebrew support
  docs: sphinx-pre-install: check GNU Make version

 Documentation/doc-guide/sphinx.rst            |   9 ++
 .../translations/zh_CN/doc-guide/sphinx.rst   |   7 +
 Documentation/translations/zh_CN/how-to.rst   |   7 +
 tools/docs/sphinx-pre-install                 | 141 +++++++++++++++++-
 4 files changed, 162 insertions(+), 2 deletions(-)

-- 
2.50.1 (Apple Git-155)