diff options
| author | Carlos Bilbao <carlos.bilbao@amd.com> | 2023-07-18 10:15:33 -0500 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2023-07-21 15:08:46 -0600 |
| commit | 48fadf44007568e75c7af92857083058d57be403 (patch) | |
| tree | 7a0c581a2e509f0e64232e8e6ae4c0df81ec12ba /Documentation/rust | |
| parent | b4047e53adef970a75cd2724800b351f64715d2c (diff) | |
| download | linux-stable-48fadf44007568e75c7af92857083058d57be403.tar.gz linux-stable-48fadf44007568e75c7af92857083058d57be403.tar.bz2 linux-stable-48fadf44007568e75c7af92857083058d57be403.zip | |
docs: Move rustdoc output, cross-reference it
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.
Reviewed-by: Akira Yokosawa <akiyks@gmail.com>
Signed-off-by: Carlos Bilbao <carlos.bilbao@amd.com>
Reviewed-by: Martin Rodriguez Reboredo <yakoyoku@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20230718151534.4067460-2-carlos.bilbao@amd.com
Diffstat (limited to 'Documentation/rust')
| -rw-r--r-- | Documentation/rust/index.rst | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/Documentation/rust/index.rst b/Documentation/rust/index.rst index 4ae8c66b94fa..e599be2cec9b 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 and html + + You can also browse `rustdoc documentation <rustdoc/kernel/index.html>`_. + +.. only:: not rustdoc and html + + This documentation does not include rustdoc generated information. + .. toctree:: :maxdepth: 1 |