Skip to contentSkip to conversation

docs/doc-guide: Mention make variable SPHINXDIRS

PATCH Applied Akira Yokosawa 3 participants 3 messages Jun 24, 2022 – Jun 30, 2022 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 docs/doc-guide: Mention make variable SPHINXDIRS

SPHINXDIRS is useful when you want to test build only those documents affected by your changes.

Mention it in the "Sphinx Build" section.

Cc Maciej W. Rozycki <[email protected]>

---
v1 -> v2:
- Added command example (Jon)

v1: https://lore.kernel.org/r/[email protected]/
--

 Documentation/doc-guide/sphinx.rst | 7 +++++++
 1 file changed, 7 insertions(+)
Documentation/doc-guide/sphinx.rst +7 -0
index edc4fa023986..1228b85f6f77 100644
@@ -151,6 +151,13 @@ If the theme is not available, it will fall-back to the classic one.
 
 The Sphinx theme can be overridden by using the ``DOCS_THEME`` make variable.
 
+There is another make variable ``SPHINXDIRS``, which is useful when test
+building a subset of documentation.  For example, you can build documents
+under ``Documentation/doc-guide`` by running
+``make SPHINXDIRS=doc-guide htmldocs``.
+The documentation section of ``make help`` will show you the list of
+subdirectories you can specify.
+
 To remove the generated documentation, run ``make cleandocs``.
 
 .. [#ink] Having ``inkscape(1)`` from Inkscape (https://inkscape.org)

base-commit: 0ebe4dd124d3a0e708ea24734c13d52657e36363

Signature · 1 line
2.25.1
#1 lore raw

Documentation/doc-guide/sphinx.rst If the theme is not available, it will fall-back to the classic one. · line 160

Quoted 7 lines · Akira Yokosawa
Documentation/doc-guide/sphinx.rst +7 -0
+There is another make variable ``SPHINXDIRS``, which is useful when test
+building a subset of documentation.  For example, you can build documents
+under ``Documentation/doc-guide`` by running
+``make SPHINXDIRS=doc-guide htmldocs``.
+The documentation section of ``make help`` will show you the list of
+subdirectories you can specify.
+

What about "The list of valid subdirectories can be found in the documentation section of ``make help``."?

Signature · 1 line
An old man doll... just what I always wanted! - Clara
maintainer Applied
#2 lore raw
In reply to Akira Yokosawa
Quoted 7 lines · Akira Yokosawa

SPHINXDIRS is useful when you want to test build only those documents affected by your changes.

Mention it in the "Sphinx Build" section.

Cc Maciej W. Rozycki <[email protected]>
Quoted 8 lines

---
v1 -> v2:
- Added command example (Jon)

v1: https://lore.kernel.org/r/[email protected]/
--

 Documentation/doc-guide/sphinx.rst | 7 +++++++
 1 file changed, 7 insertions(+)

Applied, thanks.

jon