diff options
| author | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2025-11-13 12:00:32 +0100 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2025-11-13 09:22:30 -0700 |
| commit | 62d785159c7a5ccfae87b5849b17e51cb8fce9b1 (patch) | |
| tree | 77ec102f8699e62c1b0a1115f30e87e8a6757025 | |
| parent | f64c7e113dc937e0987c83ef51a3cd52a2c277c7 (diff) | |
docs: Makefile: update SPHINXDIRS documentation
Since the beginning, SPHINXDIRS was meant to be used by any
subdirectory inside Documentation/ that contains a file named
index.rst on it. The typical usecase for SPHINXDIRS is help
building subsystem-specific documentation, without needing to
wait for the entire building (with can take 3 minutes with
Sphinx 8.x and above, and a lot more with older versions).
Yet, the documentation for such feature was written back in
2016, where almost all index.rst files were at the first
level (Documentation/*/index.rst).
Update the documentation to reflect the way it works.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <683469813350214da122c258063dd71803ff700b.1763031632.git.mchehab+huawei@kernel.org>
| -rw-r--r-- | Documentation/Makefile | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/Makefile b/Documentation/Makefile index d514ab6761dc..c66df29cf0a3 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -104,7 +104,9 @@ dochelp: @echo ' cleandocs - clean all generated files' @echo @echo ' make SPHINXDIRS="s1 s2" [target] Generate only docs of folder s1, s2' - @echo ' valid values for SPHINXDIRS are: $(_SPHINXDIRS)' + @echo ' top level values for SPHINXDIRS are: $(_SPHINXDIRS)' + @echo ' you may also use a subdirectory like SPHINXDIRS=userspace-api/media,' + @echo ' provided that there is an index.rst file at the subdirectory.' @echo @echo ' make DOCS_THEME={sphinx-theme} selects a different Sphinx theme.' @echo |
