2022-06-24 22:19:54

by 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 <[email protected]>
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(+)

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

2022-06-25 01:57:42

by Bagas Sanjaya

Subject: Re: [PATCH v2] docs/doc-guide: Mention make variable SPHINXDIRS

On 6/25/22 04:58, Akira Yokosawa wrote:
> +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``."?

--
An old man doll... just what I always wanted! - Clara

2022-06-30 19:11:49

by Jonathan Corbet

Subject: Re: [PATCH v2] docs/doc-guide: Mention make variable SPHINXDIRS

Akira Yokosawa <[email protected]> writes:

> 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 <[email protected]>
> 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(+)

Applied, thanks.

jon