Module doc_links 

Extracts, resolves and rewrites links and intra-doc links in markdown documentation.

Modules

intra_doc_links 🔒

Helper tools for intra doc links.

Structs

DocCommentToken 🔒

DocumentationLinks

Web and local links to an item’s documentation.

Constants

MARKDOWN_OPTIONS 🔒

Functions

broken_link_clone_cb 🔒

doc_attributes 🔒

external_docs 🔒

extract_definitions_from_docs 🔒

Extracts all links from a given markdown text returning the definition text range, link-text and the namespace if known.

filename_and_frag_for_def 🔒

Get the filename and extension generated for a symbol by rustdoc.

get_assoc_item_fragment 🔒

Get the fragment required to link to a specific field, method, associated type, or associated constant.

get_doc_base_urls 🔒

Get the root URL for the documentation of a definition.

get_doc_links 🔒

map_links 🔒

Rewrites a markdown document, applying ‘callback’ to each link.

mod_path_of_def 🔒

remove_links 🔒

Remove all links in markdown documentation.

resolve_doc_path_for_def 🔒

rewrite_intra_doc_link 🔒

rewrite_links 🔒

Rewrite documentation links in markdown to point to an online host (e.g. docs.rs)

rewrite_url_link 🔒

Try to resolve path to local documentation via path-based links (i.e. ../gateway/struct.Shard.html).

token_as_doc_comment 🔒