From: Carlos Bilbao <carlos.bilbao@amd.com>
To: <ojeda@kernel.org>, <corbet@lwn.net>, <akiyks@gmail.com>,
<jani.nikula@linux.intel.com>, <rdunlap@infradead.org>
Cc: <linux-doc@vger.kernel.org>, <linux-kernel@vger.kernel.org>,
<konstantin@linuxfoundation.org>,
Carlos Bilbao <carlos.bilbao@amd.com>
Subject: [PATCH v5 2/2] docs: Integrate rustdoc generation into htmldocs
Date: Wed, 28 Dec 2022 11:46:23 -0600 [thread overview]
Message-ID: <20221228174623.144199-3-carlos.bilbao@amd.com> (raw)
In-Reply-To: <20221228174623.144199-1-carlos.bilbao@amd.com>
Change target `make htmldocs` to combine RST Sphinx and the generation of
Rust documentation, when support is available.
Reviewed-by: Akira Yokosawa <akiyks@gmail.com>
Signed-off-by: Carlos Bilbao <carlos.bilbao@amd.com>
---
Documentation/Makefile | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/Documentation/Makefile b/Documentation/Makefile
index bb73dcb5ed05..edc5540ab12a 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -59,6 +59,10 @@ PAPEROPT_letter = -D latex_paper_size=letter
KERNELDOC = $(srctree)/scripts/kernel-doc
KERNELDOC_CONF = -D kerneldoc_srctree=$(srctree) -D kerneldoc_bin=$(KERNELDOC)
ALLSPHINXOPTS = $(KERNELDOC_CONF) $(PAPEROPT_$(PAPER)) $(SPHINXOPTS)
+ifeq ($(CONFIG_RUST),y)
+# Let Sphinx know we will include rustdoc
+ALLSPHINXOPTS += -t rustdoc
+endif
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
@@ -94,6 +98,10 @@ quiet_cmd_sphinx = SPHINX $@ --> file://$(abspath $(BUILDDIR)/$3/$4)
htmldocs:
@$(srctree)/scripts/sphinx-pre-install --version-check
@+$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,html,$(var),,$(var)))
+# If Rust support is available, add rustdoc generated contents
+ifeq ($(CONFIG_RUST),y)
+ $(Q)$(MAKE) rustdoc
+endif
texinfodocs:
@$(srctree)/scripts/sphinx-pre-install --version-check
--
2.34.1
next prev parent reply other threads:[~2022-12-28 17:46 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-12-07 17:30 [PATCH v4 0/2] docs: Integrate rustdoc into Rust documentation Carlos Bilbao
2022-12-07 17:30 ` [PATCH v4 1/2] docs: Move rustdoc output, cross-reference it Carlos Bilbao
2022-12-07 20:46 ` Jani Nikula
2022-12-07 22:57 ` Akira Yokosawa
2022-12-28 17:43 ` Carlos Bilbao
2022-12-07 17:30 ` [PATCH v4 2/2] docs: Integrate rustdoc generation into htmldocs Carlos Bilbao
2022-12-28 17:46 ` [PATCH v5 0/2] docs: Integrate rustdoc into Rust documentation Carlos Bilbao
2022-12-28 17:46 ` [PATCH v5 1/2] docs: Move rustdoc output, cross-reference it Carlos Bilbao
2022-12-28 17:46 ` Carlos Bilbao [this message]
2023-01-02 23:53 ` [PATCH v5 0/2] docs: Integrate rustdoc into Rust documentation Jonathan Corbet
2023-01-03 14:06 ` Carlos Bilbao
2023-01-04 0:20 ` Jonathan Corbet
2023-01-03 14:19 ` Miguel Ojeda
2023-01-04 0:25 ` Jonathan Corbet
2023-01-04 1:55 ` Miguel Ojeda
2023-01-04 14:53 ` Jonathan Corbet
2023-01-04 19:54 ` Carlos Bilbao
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=20221228174623.144199-3-carlos.bilbao@amd.com \
--to=carlos.bilbao@amd.com \
--cc=akiyks@gmail.com \
--cc=corbet@lwn.net \
--cc=jani.nikula@linux.intel.com \
--cc=konstantin@linuxfoundation.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=ojeda@kernel.org \
--cc=rdunlap@infradead.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
all inboxes | Powered by JetHome®