diff options
| author | Akira Yokosawa <akiyks@gmail.com> | 2022-06-25 06:58:09 +0900 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2022-06-30 12:23:38 -0600 |
| commit | 4d627ef12b409fd149226617180f1cc6088bbf12 (patch) | |
| tree | b6a8a623d6e5ca65fc3872280f1874e1f777842c /Documentation/doc-guide | |
| parent | 2bc6430884d5ee0e30ae18652d31f821d8e9ec32 (diff) | |
| download | linux-4d627ef12b409fd149226617180f1cc6088bbf12.tar.gz | |
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>
Link: https://lore.kernel.org/r/50d6f0bc-030d-9529-0665-e2b3e7c792d8@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/doc-guide')
| -rw-r--r-- | Documentation/doc-guide/sphinx.rst | 7 |
1 files changed, 7 insertions, 0 deletions
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) |