Commit b2bf463e authored by Miguel Ojeda's avatar Miguel Ojeda
Browse files

docs: rust: improve main page introducing a "Code documentation" section 

Clean the "Rust" main page by introducing a 'Code documentation" section
to separate it from the rest of the text above.

In addition, introduce the "Rust code documentation" term, which may be
clearer than referring to a potentially unknown tool.

Furthermore, for the HTML case, homogenize both `rustdoc` and
non-`rustdoc` cases and use the term introduced above instead.

Then, always generate the pregenerated version part, since now there
is a section that is always generated and thus makes sense to do so.

Finally, finish the new section with a link to more details about the
Rust code documentation.

The intention is that:

  - The non-HTML case mentions the code documentation too, making it
    more prominent for readers of non-HTML docs.

  - Both HTML cases read more naturally.

  - The pregenerated version is always mentioned, since it is likely
    useful for readers of non-HTML docs.

Link: https://lore.kernel.org/r/20240818141200.386899-2-ojeda@kernel.org


Signed-off-by: default avatarMiguel Ojeda <ojeda@kernel.org>
parent 0eef6ec5

Documentation/rust/general-information.rst

+2 −0
Original line number Diff line number Diff line
@@ -15,6 +15,8 @@ but not `std <https://doc.rust-lang.org/std/>`_. Crates for use in the 
kernel must opt into this behavior using the ``#![no_std]`` attribute.





.. _rust_code_documentation:



Code documentation

------------------

Documentation/rust/index.rst

+15 −4
Original line number Diff line number Diff line
@@ -25,17 +25,28 @@ support is still in development/experimental, especially for certain kernel 
configurations.





Code documentation

------------------



Given a kernel configuration, the kernel may generate Rust code documentation,

i.e. HTML rendered by the ``rustdoc`` tool.



.. only:: rustdoc and html



	You can also browse `rustdoc documentation <rustdoc/kernel/index.html>`_.

	This kernel documentation was built with `Rust code documentation

	<rustdoc/kernel/index.html>`_.



.. only:: not rustdoc and html



	This documentation does not include rustdoc generated information.

	This kernel documentation was not built with Rust code documentation.



A pregenerated version is provided at:



	https://rust.docs.kernel.org



Please see the :ref:`Code documentation <rust_code_documentation>` section for

more details.



.. toctree::

    :maxdepth: 1