* [PATCH v2] docs/doc-guide: Mention make variable SPHINXDIRS
@ 2022-06-24 21:58 Akira Yokosawa
2022-06-25 1:21 ` Bagas Sanjaya
2022-06-30 18:24 ` Jonathan Corbet
0 siblings, 2 replies; 3+ messages in thread
From: Akira Yokosawa @ 2022-06-24 21:58 UTC (permalink / raw)
To: Jonathan Corbet, linux-doc
Cc: Mauro Carvalho Chehab, Maciej W. Rozycki, Miguel Ojeda,
linux-kernel, 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.
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
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH v2] docs/doc-guide: Mention make variable SPHINXDIRS
2022-06-24 21:58 [PATCH v2] docs/doc-guide: Mention make variable SPHINXDIRS Akira Yokosawa
@ 2022-06-25 1:21 ` Bagas Sanjaya
2022-06-30 18:24 ` Jonathan Corbet
1 sibling, 0 replies; 3+ messages in thread
From: Bagas Sanjaya @ 2022-06-25 1:21 UTC (permalink / raw)
To: Akira Yokosawa, Jonathan Corbet, linux-doc
Cc: Mauro Carvalho Chehab, Maciej W. Rozycki, Miguel Ojeda, linux-kernel
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
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH v2] docs/doc-guide: Mention make variable SPHINXDIRS
2022-06-24 21:58 [PATCH v2] docs/doc-guide: Mention make variable SPHINXDIRS Akira Yokosawa
2022-06-25 1:21 ` Bagas Sanjaya
@ 2022-06-30 18:24 ` Jonathan Corbet
1 sibling, 0 replies; 3+ messages in thread
From: Jonathan Corbet @ 2022-06-30 18:24 UTC (permalink / raw)
To: Akira Yokosawa, linux-doc
Cc: Mauro Carvalho Chehab, Maciej W. Rozycki, Miguel Ojeda,
linux-kernel, Akira Yokosawa
Akira Yokosawa <akiyks@gmail.com> 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 <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(+)
Applied, thanks.
jon
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2022-06-30 18:24 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-06-24 21:58 [PATCH v2] docs/doc-guide: Mention make variable SPHINXDIRS Akira Yokosawa
2022-06-25 1:21 ` Bagas Sanjaya
2022-06-30 18:24 ` Jonathan Corbet
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).