Commit 62d78515 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet
Browse files

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: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
Message-ID: <683469813350214da122c258063dd71803ff700b.1763031632.git.mchehab+huawei@kernel.org>
parent f64c7e11

Documentation/Makefile

+3 −1
Original line number Diff line number Diff line
@@ -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