Akira Yokosawa <akiyks@xxxxxxxxx> writes: > SPHINXDIRS is useful when you want test builds of only those > documents affected by your changes. > > Mention it in the "Sphinx Build" section. > > Signed-off-by: Akira Yokosawa <akiyks@xxxxxxxxx> > Cc: Maciej W. Rozycki <macro@xxxxxxxxxxx> > --- > This change is inspired from correspondence with Maciej [1]. > > [1]: https://lore.kernel.org/r/f4d40da6-756b-9e75-b867-cc9eedc4b232@xxxxxxxxx > > -- > Documentation/doc-guide/sphinx.rst | 4 ++++ > 1 file changed, 4 insertions(+) > > diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst > index edc4fa023986..efcccab68286 100644 > --- 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? Thanks, jon
