From: Akira Yokosawa Date: Fri, 24 Jun 2022 21:58:09 +0000 (+0900) Subject: docs/doc-guide: Mention make variable SPHINXDIRS X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=4d627ef12b409fd149226617180f1cc6088bbf12;p=linux.git 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 Cc: Maciej W. Rozycki Link: https://lore.kernel.org/r/50d6f0bc-030d-9529-0665-e2b3e7c792d8@gmail.com Signed-off-by: Jonathan Corbet --- diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst index edc4fa023986a..1228b85f6f771 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)