On Thu, 09 Jun 2022 09:26:17 -0600,
Jonathan Corbet wrote:
> Akira Yokosawa <akiyks@xxxxxxxxx> writes:
[...]
>> --- a/Documentation/doc-guide/sphinx.rst
>> +++ b/Documentation/doc-guide/sphinx.rst
>> @@ -151,6 +151,10 @@ 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. Again, see the documentation section
>> +of ``make help`` for the details.
>
> This should definitely be documented, it's kind of sad that we never did
> that. Rather than redirect readers to type a "make" command, though,
> why not just tell them how to use it here?
Good point.
I have updated the hunk as follows:
+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.
Thoughts?
Thanks, Akira
>
> Thanks,
>
> jon
