sphinxcontrib_rust.rust_link

Module for enabling intra-doc links similar to Rustdoc

Functions

link(state, silent)

This is a monkey patch used to replace the markdown_it.rules_inline.link.link().

sphinxcontrib_rust.rust_link.link(state: StateInline, silent: bool) → bool

This is a monkey patch used to replace the markdown_it.rules_inline.link.link().

The main difference here is that it will mark any text with brackets as a link, even if there is no reference for it. This allows us to inject links for Rust items in the docs similar to rustdoc. However, it will also make links out of text that is not a Rust item name.

Returns:

True, if it found a link, otherwise False.