Skip to content

Commit 62d7851

Browse files
mchehabJonathan Corbet
authored andcommitted
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>
1 parent f64c7e1 commit 62d7851

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

Documentation/Makefile

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,9 @@ dochelp:
104104
@echo ' cleandocs - clean all generated files'
105105
@echo
106106
@echo ' make SPHINXDIRS="s1 s2" [target] Generate only docs of folder s1, s2'
107-
@echo ' valid values for SPHINXDIRS are: $(_SPHINXDIRS)'
107+
@echo ' top level values for SPHINXDIRS are: $(_SPHINXDIRS)'
108+
@echo ' you may also use a subdirectory like SPHINXDIRS=userspace-api/media,'
109+
@echo ' provided that there is an index.rst file at the subdirectory.'
108110
@echo
109111
@echo ' make DOCS_THEME={sphinx-theme} selects a different Sphinx theme.'
110112
@echo

0 commit comments

Comments
 (0)