sphinxcontrib_rust

Init module for the extension with the setup function used by Sphinx

Functions

generate_docs(app, config)	Generate the Rust docs once the configuration has been read
setup(app)	Set up the extension

sphinxcontrib_rust.generate_docs(app: Sphinx, config: Config)

Generate the Rust docs once the configuration has been read

Args:

app:

The Sphinx application.

config:

The parsed configuration.

sphinxcontrib_rust.setup(app: Sphinx) → Mapping[str, Any]

Set up the extension

Modules

sphinxcontrib_rust.directives	The module provides all the directive classes for the Rust object types.
sphinxcontrib_rust.domain	The module defines the RustDomain class, which is a Sphinx domain for the various concepts used within the Rust programming language.
sphinxcontrib_rust.index	The module defines the RustIndex class which is the base class for the indices generated for Rust objects.
sphinxcontrib_rust.items	This module provides an enum for the various object types for the Rust domain.