lkml.org 
[lkml]   [2022]   [Dec]   [7]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
Date
SubjectRe: [PATCH v4 1/2] docs: Move rustdoc output, cross-reference it
From
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@gmail.com>
> Signed-off-by: Carlos Bilbao <carlos.bilbao@amd.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.

--
\
 
 \ /
  Last update: 2022-12-07 23:58    [W:0.089 / U:0.436 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site