]> www.infradead.org Git - users/jedix/linux-maple.git/commit
docs: rust: improve main page introducing a "Code documentation" section
authorMiguel Ojeda <ojeda@kernel.org>
Sun, 18 Aug 2024 14:12:00 +0000 (16:12 +0200)
committerMiguel Ojeda <ojeda@kernel.org>
Sun, 25 Aug 2024 16:37:40 +0000 (18:37 +0200)
commitb2bf463ed9a8131ad4e91a11af8c9a4ec84b876a
tree7afb992969179a321bd8d6100fe83bfec2e18383
parent0eef6ec5a8e5bc2d633d6716f2640de8d6b45da7
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: Miguel Ojeda <ojeda@kernel.org>
Documentation/rust/general-information.rst
Documentation/rust/index.rst