Messages in this thread Patch in this message | | | Date | Sat, 25 Jun 2022 06:58:09 +0900 | From | Akira Yokosawa <> | Subject | [PATCH v2] 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.
Signed-off-by: Akira Yokosawa <akiyks@gmail.com> Cc: Maciej W. Rozycki <macro@orcam.me.uk> --- v1 -> v2: - Added command example (Jon)
v1: https://lore.kernel.org/r/ff89c064-e24a-0f2f-fc03-b029e5d04338@gmail.com/ -- Documentation/doc-guide/sphinx.rst | 7 +++++++ 1 file changed, 7 insertions(+)
diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst index edc4fa023986..1228b85f6f77 100644 --- a/Documentation/doc-guide/sphinx.rst +++ b/Documentation/doc-guide/sphinx.rst @@ -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 -- 2.25.1
| |