[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <20221207173053.1463800-3-carlos.bilbao@amd.com>
Date: Wed, 7 Dec 2022 11:30:53 -0600
From: Carlos Bilbao <carlos.bilbao@....com>
To: <ojeda@...nel.org>, <corbet@....net>, <akiyks@...il.com>,
<jani.nikula@...ux.intel.com>, <rdunlap@...radead.org>
CC: <linux-doc@...r.kernel.org>, <linux-kernel@...r.kernel.org>,
<konstantin@...uxfoundation.org>,
Carlos Bilbao <carlos.bilbao@....com>
Subject: [PATCH v4 2/2] docs: Integrate rustdoc generation into htmldocs
Change target `make htmldocs` to combine RST Sphinx and the generation of
Rust documentation, when support is available.
Reviewed-by: Akira Yokosawa <akiyks@...il.com>
Signed-off-by: Carlos Bilbao <carlos.bilbao@....com>
---
Documentation/Makefile | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/Documentation/Makefile b/Documentation/Makefile
index 64d44c1ecad3..701ccb07e873 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
linkcheckdocs:
@$(foreach var,$(SPHINXDIRS),$(call loop_cmd,sphinx,linkcheck,$(var),,$(var)))
--
2.34.1
Powered by blists - more mailing lists