[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <e3d15de9-521c-5017-112a-6cc7fcd54437@gmail.com>
Date: Thu, 8 Dec 2022 07:57:50 +0900
From: Akira Yokosawa <akiyks@...il.com>
To: Carlos Bilbao <carlos.bilbao@....com>
Cc: linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
konstantin@...uxfoundation.org, ojeda@...nel.org, corbet@....net,
jani.nikula@...ux.intel.com, rdunlap@...radead.org,
Akira Yokosawa <akiyks@...il.com>
Subject: Re: [PATCH v4 1/2] docs: Move rustdoc output, cross-reference it
Hi,
On Wed, 7 Dec 2022 11:30:52 -0600, Carlos Bilbao wrote:
> Generate rustdoc documentation with the rest of subsystem's documentation
> in Documentation/output. Add a cross reference to the generated rustdoc in
> Documentation/rust/index.rst if Sphinx target rustdoc is set.
The note on rustdoc won't help much in non-html outputs.
Please apply patch below on top.
You can keep my Rb tag.
When rustdoc arrives at https://www.kernel.org/doc/, a note
for non-html outputs directing people there might be helpful,
I guess.
Thanks, Akira
>
> Reviewed-by: Akira Yokosawa <akiyks@...il.com>
> Signed-off-by: Carlos Bilbao <carlos.bilbao@....com>
> ---
> Documentation/rust/index.rst | 8 ++++++++
> rust/Makefile | 15 +++++++++------
> 2 files changed, 17 insertions(+), 6 deletions(-)
>
> diff --git a/Documentation/rust/index.rst b/Documentation/rust/index.rst
> index 4ae8c66b94fa..4fc97c1eb1d1 100644
> --- a/Documentation/rust/index.rst
> +++ b/Documentation/rust/index.rst
> @@ -6,6 +6,14 @@ Rust
> Documentation related to Rust within the kernel. To start using Rust
> in the kernel, please read the quick-start.rst guide.
>
> +.. only:: rustdoc
> +
> + You can also browse `rustdoc documentation <rustdoc/kernel/index.html>`_.
> +
> +.. only:: not rustdoc
> +
> + This documentation does not include rustdoc generated information.
> +
> .. toctree::
> :maxdepth: 1
>
--- a/Documentation/rust/index.rst
+++ b/Documentation/rust/index.rst
@@ -6,11 +6,11 @@ Rust
Documentation related to Rust within the kernel. To start using Rust
in the kernel, please read the quick-start.rst guide.
-.. only:: rustdoc
+.. only:: rustdoc and html
You can also browse `rustdoc documentation <rustdoc/kernel/index.html>`_.
-.. only:: not rustdoc
+.. only:: not rustdoc and html
This documentation does not include rustdoc generated information.
--
Powered by blists - more mailing lists