From: Akira Yokosawa <akiyks@gmail.com>
To: Jonathan Corbet <corbet@lwn.net>, linux-doc@vger.kernel.org
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>,
"Maciej W. Rozycki" <macro@orcam.me.uk>,
Miguel Ojeda <ojeda@kernel.org>,
linux-kernel@vger.kernel.org, Akira Yokosawa <akiyks@gmail.com>
Subject: [PATCH 2/5] docs/doc-guide: Mention make variable SPHINXDIRS
Date: Thu, 9 Jun 2022 22:24:58 +0900 [thread overview]
Message-ID: <ff89c064-e24a-0f2f-fc03-b029e5d04338@gmail.com> (raw)
In-Reply-To: <dccb5233-7f4f-1be6-d1f4-bbe9f42f88e0@gmail.com>
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@gmail.com>
Cc: Maciej W. Rozycki <macro@orcam.me.uk>
---
This change is inspired from correspondence with Maciej [1].
[1]: https://lore.kernel.org/r/f4d40da6-756b-9e75-b867-cc9eedc4b232@gmail.com
--
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.
+
To remove the generated documentation, run ``make cleandocs``.
.. [#ink] Having ``inkscape(1)`` from Inkscape (https://inkscape.org)
--
2.25.1
next prev parent reply other threads:[~2022-06-09 13:25 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-06-09 13:21 [PATCH 0/5] docs/doc-guide: Sphinx related updates Akira Yokosawa
2022-06-09 13:23 ` [PATCH 1/5] docs/doc-guide: Add footnote on Inkscape for better images in PDF documents Akira Yokosawa
2022-06-09 13:24 ` Akira Yokosawa [this message]
2022-06-09 15:26 ` [PATCH 2/5] docs/doc-guide: Mention make variable SPHINXDIRS Jonathan Corbet
2022-06-10 1:58 ` Akira Yokosawa
2022-06-09 13:26 ` [RFC PATCH 3/5] docs/doc-guide: Update guidelines for title adornments Akira Yokosawa
2022-06-10 9:11 ` Jani Nikula
2022-06-10 16:08 ` Miguel Ojeda
2022-06-11 3:15 ` Akira Yokosawa
2022-06-11 23:25 ` Mauro Carvalho Chehab
2022-06-09 13:27 ` [RFC PATCH 4/5] docs/doc-guide: Pull guidelines for title adornments out into subsection Akira Yokosawa
2022-06-09 13:28 ` [PATCH 5/5] docs/doc-guide: Put meta title for kernel-doc HTML page Akira Yokosawa
2022-06-10 16:50 ` [PATCH 0/5] docs/doc-guide: Sphinx related updates Miguel Ojeda
2022-06-24 19:59 ` Jonathan Corbet
2022-06-24 21:48 ` Akira Yokosawa
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=ff89c064-e24a-0f2f-fc03-b029e5d04338@gmail.com \
--to=akiyks@gmail.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=macro@orcam.me.uk \
--cc=mchehab@kernel.org \
--cc=ojeda@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).