sphinxcontrib-rust
Detailed docs
Including the docs in the Sphinx build
Rust specific roles
Rust specific directives
Rust items index
Limitations
Compatibility with rustdoc
Developer Documentation
sphinx-rustdocgen documentation
sphinxcontrib_rust documentation
Release Notes
Contributing to sphinxcontrib-rust
sphinxcontrib-rust
Index
Index
A
|
C
|
D
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
A
add_target_and_index() (sphinxcontrib_rust.directives.RustDirective method)
C
clear_doc() (sphinxcontrib_rust.domain.RustDomain method)
CrateConfiguration (class in sphinxcontrib_rust)
create_signature() (sphinxcontrib_rust.nodes.Node class method)
D
data (sphinxcontrib_rust.domain.RustDomain attribute)
data_version (sphinxcontrib_rust.domain.RustDomain attribute)
directives (sphinxcontrib_rust.domain.RustDomain attribute)
disambiguated_target() (sphinxcontrib_rust.items.RustItemType static method)
display_text (sphinxcontrib_rust.items.RustItemType property)
F
find_item() (sphinxcontrib_rust.domain.RustDomain method)
find_item_by_name() (sphinxcontrib_rust.domain.RustDomain method)
from_sphinx_config() (sphinxcontrib_rust.CrateConfiguration class method)
from_str() (sphinxcontrib_rust.items.RustItemType class method)
(sphinxcontrib_rust.nodes.NodeType class method)
G
generate() (sphinxcontrib_rust.index.RustIndex method)
generate_docs() (in module sphinxcontrib_rust)
get_directives() (sphinxcontrib_rust.directives.RustDirective class method)
get_objects() (sphinxcontrib_rust.domain.RustDomain method)
get_roles() (sphinxcontrib_rust.items.RustItemType method)
get_sphinx_obj_type() (sphinxcontrib_rust.items.RustItemType method)
H
handle_signature() (sphinxcontrib_rust.directives.RustDirective method)
has_content (sphinxcontrib_rust.directives.RustUseDirective attribute)
I
index_section_name (sphinxcontrib_rust.items.RustItemType property)
indices (sphinxcontrib_rust.domain.RustDomain attribute)
initial_data (sphinxcontrib_rust.domain.RustDomain attribute)
items (sphinxcontrib_rust.domain.RustDomain property)
iter_roles() (sphinxcontrib_rust.items.RustItemType static method)
L
label (sphinxcontrib_rust.domain.RustDomain attribute)
link() (in module sphinxcontrib_rust.rust_link)
M
make_index_entry() (sphinxcontrib_rust.items.RustItem method)
merge_domaindata() (sphinxcontrib_rust.domain.RustDomain method)
module
sphinxcontrib_rust
sphinxcontrib_rust.directives
sphinxcontrib_rust.domain
sphinxcontrib_rust.index
sphinxcontrib_rust.items
sphinxcontrib_rust.nodes
sphinxcontrib_rust.rust_link
N
name (sphinxcontrib_rust.domain.RustDomain attribute)
Node (class in sphinxcontrib_rust.nodes)
NodeType (class in sphinxcontrib_rust.nodes)
O
object_types (sphinxcontrib_rust.domain.RustDomain attribute)
option_spec (sphinxcontrib_rust.directives.RustDirective attribute)
(sphinxcontrib_rust.directives.RustUseDirective attribute)
P
process_link() (sphinxcontrib_rust.domain.RustXRefRole method)
R
resolve_any_xref() (sphinxcontrib_rust.domain.RustDomain method)
resolve_xref() (sphinxcontrib_rust.domain.RustDomain method)
roles (sphinxcontrib_rust.domain.RustDomain attribute)
run() (sphinxcontrib_rust.directives.RustUseDirective method)
rust:any (role)
rust:crate (directive)
(role)
rust:enum (directive)
(role)
rust:exe (role)
rust:executable (directive)
(role)
rust:fn (role)
rust:function (directive)
(role)
rust:impl (directive)
(role)
rust:macro (directive)
(role)
rust:module (directive)
(role)
rust:struct (directive)
(role)
rust:trait (directive)
(role)
rust:type (directive)
(role)
rust:use (directive)
rust:var (role)
rust:variable (directive)
(role)
rust_item_type (sphinxcontrib_rust.directives.RustCrateDirective property)
(sphinxcontrib_rust.directives.RustDirective property)
(sphinxcontrib_rust.directives.RustEnumDirective property)
(sphinxcontrib_rust.directives.RustExecutableDirective property)
(sphinxcontrib_rust.directives.RustFunctionDirective property)
(sphinxcontrib_rust.directives.RustImplDirective property)
(sphinxcontrib_rust.directives.RustMacroDirective property)
(sphinxcontrib_rust.directives.RustModuleDirective property)
(sphinxcontrib_rust.directives.RustStructDirective property)
(sphinxcontrib_rust.directives.RustTraitDirective property)
(sphinxcontrib_rust.directives.RustTypeDirective property)
(sphinxcontrib_rust.directives.RustUseDirective property)
(sphinxcontrib_rust.directives.RustVariableDirective property)
RustCrateDirective (class in sphinxcontrib_rust.directives)
RustDirective (class in sphinxcontrib_rust.directives)
RustDomain (class in sphinxcontrib_rust.domain)
RustEnumDirective (class in sphinxcontrib_rust.directives)
RustExecutableDirective (class in sphinxcontrib_rust.directives)
RustFunctionDirective (class in sphinxcontrib_rust.directives)
RustImplDirective (class in sphinxcontrib_rust.directives)
RustIndex (class in sphinxcontrib_rust.index)
RustItem (class in sphinxcontrib_rust.items)
RustItemType (class in sphinxcontrib_rust.items)
RustMacroDirective (class in sphinxcontrib_rust.directives)
RustModuleDirective (class in sphinxcontrib_rust.directives)
RustStructDirective (class in sphinxcontrib_rust.directives)
RustTraitDirective (class in sphinxcontrib_rust.directives)
RustTypeDirective (class in sphinxcontrib_rust.directives)
RustUseDirective (class in sphinxcontrib_rust.directives)
RustVariableDirective (class in sphinxcontrib_rust.directives)
RustXRefRole (class in sphinxcontrib_rust.domain)
S
setup() (in module sphinxcontrib_rust)
sphinx-rustdocgen
sphinx-rustdocgen::main
sphinx-rustdocgen::USAGE
sphinx_rustdocgen
sphinx_rustdocgen::Configuration
sphinx_rustdocgen::Configuration::crate_dir
sphinx_rustdocgen::Configuration::crate_name
sphinx_rustdocgen::Configuration::doc_dir
sphinx_rustdocgen::Configuration::force
sphinx_rustdocgen::Configuration::format
sphinx_rustdocgen::Configuration::strip_src
sphinx_rustdocgen::Configuration::visibility
sphinx_rustdocgen::directives
sphinx_rustdocgen::directives::crate_directive
sphinx_rustdocgen::directives::crate_directive::CrateDirective
sphinx_rustdocgen::directives::crate_directive::CrateDirective::content
sphinx_rustdocgen::directives::crate_directive::CrateDirective::doc_file
sphinx_rustdocgen::directives::crate_directive::CrateDirective::file_directives
sphinx_rustdocgen::directives::crate_directive::CrateDirective::name
sphinx_rustdocgen::directives::crate_directive::CrateDirective::options
sphinx_rustdocgen::directives::Directive
sphinx_rustdocgen::directives::Directive::Crate
sphinx_rustdocgen::directives::Directive::Enum
sphinx_rustdocgen::directives::Directive::Executable
sphinx_rustdocgen::directives::Directive::Function
sphinx_rustdocgen::directives::Directive::Impl
sphinx_rustdocgen::directives::Directive::Macro
sphinx_rustdocgen::directives::Directive::Module
sphinx_rustdocgen::directives::Directive::Struct
sphinx_rustdocgen::directives::Directive::Trait
sphinx_rustdocgen::directives::Directive::Type
sphinx_rustdocgen::directives::Directive::Use
sphinx_rustdocgen::directives::Directive::Variable
sphinx_rustdocgen::directives::directive_options
sphinx_rustdocgen::directives::directive_options::DirectiveOption
sphinx_rustdocgen::directives::directive_options::DirectiveOption::Index
sphinx_rustdocgen::directives::directive_options::DirectiveOption::Layout
sphinx_rustdocgen::directives::directive_options::DirectiveOption::Toc
sphinx_rustdocgen::directives::directive_options::DirectiveOption::Vis
sphinx_rustdocgen::directives::directive_options::DirectiveVisibility
sphinx_rustdocgen::directives::directive_options::DirectiveVisibility::Crate
sphinx_rustdocgen::directives::directive_options::DirectiveVisibility::Pub
sphinx_rustdocgen::directives::directive_options::DirectiveVisibility::Pvt
sphinx_rustdocgen::directives::directive_options::IndexEntryType
sphinx_rustdocgen::directives::directive_options::IndexEntryType::None
sphinx_rustdocgen::directives::directive_options::IndexEntryType::Normal
sphinx_rustdocgen::directives::directive_options::IndexEntryType::SubEntry
sphinx_rustdocgen::directives::directive_options::IndexEntryType::WithSubEntries
sphinx_rustdocgen::directives::enum_directive
sphinx_rustdocgen::directives::enum_directive::EnumDirective
sphinx_rustdocgen::directives::enum_directive::EnumDirective::content
sphinx_rustdocgen::directives::enum_directive::EnumDirective::ident
sphinx_rustdocgen::directives::enum_directive::EnumDirective::name
sphinx_rustdocgen::directives::enum_directive::EnumDirective::options
sphinx_rustdocgen::directives::enum_directive::EnumDirective::self_impls
sphinx_rustdocgen::directives::enum_directive::EnumDirective::trait_impls
sphinx_rustdocgen::directives::enum_directive::EnumDirective::variants
sphinx_rustdocgen::directives::executable_directive
sphinx_rustdocgen::directives::executable_directive::ExecutableDirective
sphinx_rustdocgen::directives::extract_doc_from_attrs
sphinx_rustdocgen::directives::FileDirectives
sphinx_rustdocgen::directives::FileDirectives::impls
sphinx_rustdocgen::directives::FileDirectives::items
sphinx_rustdocgen::directives::FileDirectives::modules
sphinx_rustdocgen::directives::FileDirectives::uses
sphinx_rustdocgen::directives::function_directive
sphinx_rustdocgen::directives::function_directive::func_from_item
sphinx_rustdocgen::directives::function_directive::FunctionDirective
sphinx_rustdocgen::directives::function_directive::FunctionDirective::content
sphinx_rustdocgen::directives::function_directive::FunctionDirective::ident
sphinx_rustdocgen::directives::function_directive::FunctionDirective::name
sphinx_rustdocgen::directives::function_directive::FunctionDirective::options
sphinx_rustdocgen::directives::function_directive::nodes_for_fn_signature
sphinx_rustdocgen::directives::impl_directive
sphinx_rustdocgen::directives::impl_directive::ImplDirective
sphinx_rustdocgen::directives::impl_directive::ImplDirective::content
sphinx_rustdocgen::directives::impl_directive::ImplDirective::items
sphinx_rustdocgen::directives::impl_directive::ImplDirective::name
sphinx_rustdocgen::directives::impl_directive::ImplDirective::options
sphinx_rustdocgen::directives::impl_directive::ImplDirective::resolved_self_ty
sphinx_rustdocgen::directives::impl_directive::ImplDirective::resolved_trait
sphinx_rustdocgen::directives::impl_directive::ImplDirective::self_ty
sphinx_rustdocgen::directives::impl_directive::ImplDirective::trait_
sphinx_rustdocgen::directives::impl_directive::nodes_for_impl
sphinx_rustdocgen::directives::ItemSections
sphinx_rustdocgen::directives::macro_directive
sphinx_rustdocgen::directives::macro_directive::MacroDirective
sphinx_rustdocgen::directives::macro_directive::MacroDirective::content
sphinx_rustdocgen::directives::macro_directive::MacroDirective::ident
sphinx_rustdocgen::directives::macro_directive::MacroDirective::name
sphinx_rustdocgen::directives::macro_directive::MacroDirective::options
sphinx_rustdocgen::directives::module_directive
sphinx_rustdocgen::directives::module_directive::find_file_under_dir
sphinx_rustdocgen::directives::module_directive::has_test_token
sphinx_rustdocgen::directives::module_directive::ModuleAttrs
sphinx_rustdocgen::directives::module_directive::ModuleAttrs::is_test
sphinx_rustdocgen::directives::module_directive::ModuleAttrs::path
sphinx_rustdocgen::directives::module_directive::ModuleDirective
sphinx_rustdocgen::directives::module_directive::ModuleDirective::content
sphinx_rustdocgen::directives::module_directive::ModuleDirective::doc_file
sphinx_rustdocgen::directives::module_directive::ModuleDirective::file_directives
sphinx_rustdocgen::directives::module_directive::ModuleDirective::ident
sphinx_rustdocgen::directives::module_directive::ModuleDirective::name
sphinx_rustdocgen::directives::module_directive::ModuleDirective::options
sphinx_rustdocgen::directives::module_directive::ModuleDirective::source_code_file
sphinx_rustdocgen::directives::order_items
sphinx_rustdocgen::directives::push_sorted
sphinx_rustdocgen::directives::struct_directive
sphinx_rustdocgen::directives::struct_directive::make_nodes
sphinx_rustdocgen::directives::struct_directive::StructDirective
sphinx_rustdocgen::directives::struct_directive::StructDirective::content
sphinx_rustdocgen::directives::struct_directive::StructDirective::fields
sphinx_rustdocgen::directives::struct_directive::StructDirective::ident
sphinx_rustdocgen::directives::struct_directive::StructDirective::name
sphinx_rustdocgen::directives::struct_directive::StructDirective::options
sphinx_rustdocgen::directives::struct_directive::StructDirective::self_impls
sphinx_rustdocgen::directives::struct_directive::StructDirective::trait_impls
sphinx_rustdocgen::directives::trait_directive
sphinx_rustdocgen::directives::trait_directive::TraitDirective
sphinx_rustdocgen::directives::trait_directive::TraitDirective::content
sphinx_rustdocgen::directives::trait_directive::TraitDirective::ident
sphinx_rustdocgen::directives::trait_directive::TraitDirective::impls
sphinx_rustdocgen::directives::trait_directive::TraitDirective::items
sphinx_rustdocgen::directives::trait_directive::TraitDirective::name
sphinx_rustdocgen::directives::trait_directive::TraitDirective::options
sphinx_rustdocgen::directives::type_directive
sphinx_rustdocgen::directives::type_directive::type_from_item
sphinx_rustdocgen::directives::type_directive::TypeDirective
sphinx_rustdocgen::directives::type_directive::TypeDirective::content
sphinx_rustdocgen::directives::type_directive::TypeDirective::ident
sphinx_rustdocgen::directives::type_directive::TypeDirective::name
sphinx_rustdocgen::directives::type_directive::TypeDirective::options
sphinx_rustdocgen::directives::use_directive
sphinx_rustdocgen::directives::use_directive::UseDirective
sphinx_rustdocgen::directives::use_directive::UseDirective::content
sphinx_rustdocgen::directives::use_directive::UseDirective::directive_visibility
sphinx_rustdocgen::directives::use_directive::UseDirective::paths
sphinx_rustdocgen::directives::use_directive::UseDirective::reexport
sphinx_rustdocgen::directives::use_directive::UseDirectiveOption
sphinx_rustdocgen::directives::use_directive::UseDirectiveOption::Reexport
sphinx_rustdocgen::directives::use_directive::UseDirectiveOption::UsedName
sphinx_rustdocgen::directives::use_directive::UsePathBuilder
sphinx_rustdocgen::directives::use_directive::UsePathBuilder::path
sphinx_rustdocgen::directives::use_directive::UsePathBuilder::used_name
sphinx_rustdocgen::directives::variable_directive
sphinx_rustdocgen::directives::variable_directive::var_from_item
sphinx_rustdocgen::directives::variable_directive::VariableDirective
sphinx_rustdocgen::directives::variable_directive::VariableDirective::content
sphinx_rustdocgen::directives::variable_directive::VariableDirective::ident
sphinx_rustdocgen::directives::variable_directive::VariableDirective::name
sphinx_rustdocgen::directives::variable_directive::VariableDirective::options
sphinx_rustdocgen::formats
sphinx_rustdocgen::formats::Format
sphinx_rustdocgen::formats::Format::Md
sphinx_rustdocgen::formats::Format::Rst
sphinx_rustdocgen::formats::generate_decoration
sphinx_rustdocgen::formats::MdContent
sphinx_rustdocgen::formats::MdContent::get_md_text
sphinx_rustdocgen::formats::MdDirective
sphinx_rustdocgen::formats::MdDirective::calc_fence_size
sphinx_rustdocgen::formats::MdDirective::fence_size
sphinx_rustdocgen::formats::MdDirective::get_md_text
sphinx_rustdocgen::formats::MdDirective::make_fence
sphinx_rustdocgen::formats::MdDirective::make_md_header
sphinx_rustdocgen::formats::MdDirective::make_md_list
sphinx_rustdocgen::formats::MdDirective::make_md_section
sphinx_rustdocgen::formats::MdDirective::make_md_toctree
sphinx_rustdocgen::formats::MdOption
sphinx_rustdocgen::formats::MdOption::get_md_text
sphinx_rustdocgen::formats::RstContent
sphinx_rustdocgen::formats::RstContent::get_rst_text
sphinx_rustdocgen::formats::RstDirective
sphinx_rustdocgen::formats::RstDirective::get_rst_text
sphinx_rustdocgen::formats::RstDirective::make_content_indent
sphinx_rustdocgen::formats::RstDirective::make_indent
sphinx_rustdocgen::formats::RstDirective::make_rst_header
sphinx_rustdocgen::formats::RstDirective::make_rst_list
sphinx_rustdocgen::formats::RstDirective::make_rst_section
sphinx_rustdocgen::formats::RstDirective::make_rst_toctree
sphinx_rustdocgen::formats::RstOption
sphinx_rustdocgen::formats::RstOption::get_rst_text
sphinx_rustdocgen::nodes
sphinx_rustdocgen::nodes::Node
sphinx_rustdocgen::nodes::Node::Indent
sphinx_rustdocgen::nodes::Node::Keyword
sphinx_rustdocgen::nodes::Node::Lifetime
sphinx_rustdocgen::nodes::Node::Link
sphinx_rustdocgen::nodes::Node::Literal
sphinx_rustdocgen::nodes::Node::Name
sphinx_rustdocgen::nodes::Node::Newline
sphinx_rustdocgen::nodes::Node::Operator
sphinx_rustdocgen::nodes::Node::Punctuation
sphinx_rustdocgen::nodes::Node::Returns
sphinx_rustdocgen::nodes::Node::Space
sphinx_rustdocgen::nodes::nodes_for_abi_opt
sphinx_rustdocgen::nodes::nodes_for_angle_bracket_generic_args
sphinx_rustdocgen::nodes::nodes_for_bare_fn
sphinx_rustdocgen::nodes::nodes_for_bound_lifetimes
sphinx_rustdocgen::nodes::nodes_for_expr_lit
sphinx_rustdocgen::nodes::nodes_for_generic_argument
sphinx_rustdocgen::nodes::nodes_for_generic_param
sphinx_rustdocgen::nodes::nodes_for_generics
sphinx_rustdocgen::nodes::nodes_for_lifetime_param
sphinx_rustdocgen::nodes::nodes_for_parenthesized_generic_args
sphinx_rustdocgen::nodes::nodes_for_pat
sphinx_rustdocgen::nodes::nodes_for_pat_type
sphinx_rustdocgen::nodes::nodes_for_path
sphinx_rustdocgen::nodes::nodes_for_path_segment
sphinx_rustdocgen::nodes::nodes_for_return_type
sphinx_rustdocgen::nodes::nodes_for_type
sphinx_rustdocgen::nodes::nodes_for_type_param
sphinx_rustdocgen::nodes::nodes_for_type_param_bound
sphinx_rustdocgen::nodes::nodes_for_type_param_bounds
sphinx_rustdocgen::nodes::nodes_for_where_clause
sphinx_rustdocgen::nodes::type_name
sphinx_rustdocgen::nodes::type_param_bound_name
sphinx_rustdocgen::nodes::type_path_name
sphinx_rustdocgen::RuntimeConfiguration
sphinx_rustdocgen::RuntimeConfiguration::crate_dir
sphinx_rustdocgen::RuntimeConfiguration::crate_name
sphinx_rustdocgen::RuntimeConfiguration::doc_dir
sphinx_rustdocgen::RuntimeConfiguration::executables
sphinx_rustdocgen::RuntimeConfiguration::force
sphinx_rustdocgen::RuntimeConfiguration::format
sphinx_rustdocgen::RuntimeConfiguration::lib
sphinx_rustdocgen::RuntimeConfiguration::max_visibility
sphinx_rustdocgen::RuntimeConfiguration::src_dir
sphinx_rustdocgen::traverse_crate
sphinx_rustdocgen::utils
sphinx_rustdocgen::utils::CargoManifest
sphinx_rustdocgen::utils::check_for_manifest
sphinx_rustdocgen::utils::FileTopLevelDirective
sphinx_rustdocgen::utils::FileTopLevelDirective::get_doc_file
sphinx_rustdocgen::utils::FileTopLevelDirective::get_text
sphinx_rustdocgen::utils::SourceCodeFile
sphinx_rustdocgen::utils::SourceCodeFile::item
sphinx_rustdocgen::utils::SourceCodeFile::path
sphinxcontrib_rust
module
sphinxcontrib_rust.directives
module
sphinxcontrib_rust.domain
module
sphinxcontrib_rust.index
module
sphinxcontrib_rust.items
module
sphinxcontrib_rust.nodes
module
sphinxcontrib_rust.rust_link
module
SphinxIndexEntryType (class in sphinxcontrib_rust.items)
T
text (sphinxcontrib_rust.nodes.Node property)
to_docutils_node() (sphinxcontrib_rust.nodes.Node method)
U
uses (sphinxcontrib_rust.domain.RustDomain property)