sphinxcontrib-rust
v0.2.0
Detailed docs
Including the docs in the Sphinx build
Rust specific roles
Rust specific directives
Rust specific indices
Developer Documentation
sphinx-rustdocgen documentation
sphinxcontrib_rust documentation
TODO list
Contributing to sphinxcontrib-rust
sphinxcontrib-rust
Index
Edit on GitLab
Index
A
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
V
A
add_target_and_index() (sphinxcontrib_rust.directives.RustDirective method)
C
clear_doc() (sphinxcontrib_rust.domain.RustDomain method)
CrateIndex (class in sphinxcontrib_rust.index)
D
data (sphinxcontrib_rust.domain.RustDomain attribute)
data_version (sphinxcontrib_rust.domain.RustDomain attribute)
directives (sphinxcontrib_rust.domain.RustDomain attribute)
display_name (sphinxcontrib_rust.items.RustItemType property)
E
EnumIndex (class in sphinxcontrib_rust.index)
F
from_str() (sphinxcontrib_rust.items.RustItemType class method)
FunctionIndex (class in sphinxcontrib_rust.index)
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_signatures() (sphinxcontrib_rust.directives.RustDirective method)
get_sphinx_obj_type() (sphinxcontrib_rust.items.RustItemType method)
H
handle_signature() (sphinxcontrib_rust.directives.RustDirective method)
I
indices (sphinxcontrib_rust.domain.RustDomain attribute)
initial_data (sphinxcontrib_rust.domain.RustDomain attribute)
iter_roles() (sphinxcontrib_rust.items.RustItemType static method)
L
label (sphinxcontrib_rust.domain.RustDomain attribute)
M
merge_domaindata() (sphinxcontrib_rust.domain.RustDomain method)
module
sphinxcontrib_rust
sphinxcontrib_rust.directives
sphinxcontrib_rust.domain
sphinxcontrib_rust.index
sphinxcontrib_rust.items
ModuleIndex (class in sphinxcontrib_rust.index)
N
name (sphinxcontrib_rust.domain.RustDomain attribute)
O
object_types (sphinxcontrib_rust.domain.RustDomain attribute)
option_spec (sphinxcontrib_rust.directives.RustDirective 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)
rust_item_type (sphinxcontrib_rust.directives.RustCrateDirective property)
(sphinxcontrib_rust.directives.RustDirective property)
(sphinxcontrib_rust.directives.RustEnumDirective 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.RustVariableDirective property)
rust_obj_type (sphinxcontrib_rust.index.CrateIndex property)
(sphinxcontrib_rust.index.EnumIndex property)
(sphinxcontrib_rust.index.FunctionIndex property)
(sphinxcontrib_rust.index.ModuleIndex property)
(sphinxcontrib_rust.index.RustIndex property)
(sphinxcontrib_rust.index.StructIndex property)
(sphinxcontrib_rust.index.TraitIndex property)
(sphinxcontrib_rust.index.TypeIndex property)
(sphinxcontrib_rust.index.VariableIndex 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)
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)
RustVariableDirective (class in sphinxcontrib_rust.directives)
RustXRefRole (class in sphinxcontrib_rust.domain)
S
setup() (in module sphinxcontrib_rust)
sphinx-rustdocgen
sphinx-rustdocgen::check_and_create_output_dir
sphinx-rustdocgen::check_crate_src_dir
sphinx-rustdocgen::directives
sphinx-rustdocgen::directives::check_visibility
sphinx-rustdocgen::directives::crate_directive
sphinx-rustdocgen::directives::crate_directive::CrateDirective
,
[1]
sphinx-rustdocgen::directives::crate_directive::CrateDirective::content
sphinx-rustdocgen::directives::crate_directive::CrateDirective::items
sphinx-rustdocgen::directives::crate_directive::CrateDirective::MdDirective
sphinx-rustdocgen::directives::crate_directive::CrateDirective::MdDirective::fence_size
sphinx-rustdocgen::directives::crate_directive::CrateDirective::MdDirective::get_md_text
sphinx-rustdocgen::directives::crate_directive::CrateDirective::name
sphinx-rustdocgen::directives::crate_directive::CrateDirective::new
sphinx-rustdocgen::directives::crate_directive::CrateDirective::options
sphinx-rustdocgen::directives::crate_directive::CrateDirective::RstDirective
sphinx-rustdocgen::directives::crate_directive::CrateDirective::RstDirective::get_rst_text
sphinx-rustdocgen::directives::Directive
,
[1]
sphinx-rustdocgen::directives::Directive::Crate
sphinx-rustdocgen::directives::Directive::Display
sphinx-rustdocgen::directives::Directive::Display::fmt
sphinx-rustdocgen::directives::Directive::Enum
sphinx-rustdocgen::directives::Directive::from_impl_item
sphinx-rustdocgen::directives::Directive::from_impl_items
sphinx-rustdocgen::directives::Directive::from_item
sphinx-rustdocgen::directives::Directive::from_items
sphinx-rustdocgen::directives::Directive::from_trait_item
sphinx-rustdocgen::directives::Directive::from_trait_items
sphinx-rustdocgen::directives::Directive::Function
sphinx-rustdocgen::directives::Directive::Impl
sphinx-rustdocgen::directives::Directive::Macro
sphinx-rustdocgen::directives::Directive::MdDirective
sphinx-rustdocgen::directives::Directive::MdDirective::fence_size
sphinx-rustdocgen::directives::Directive::MdDirective::get_md_text
sphinx-rustdocgen::directives::Directive::Module
sphinx-rustdocgen::directives::Directive::name
sphinx-rustdocgen::directives::Directive::RstDirective
sphinx-rustdocgen::directives::Directive::RstDirective::get_rst_text
sphinx-rustdocgen::directives::Directive::Struct
sphinx-rustdocgen::directives::Directive::Trait
sphinx-rustdocgen::directives::Directive::Type
sphinx-rustdocgen::directives::Directive::Variable
sphinx-rustdocgen::directives::DirectiveOption
sphinx-rustdocgen::directives::DirectiveOption::MdOption
sphinx-rustdocgen::directives::DirectiveOption::MdOption::get_md_text
sphinx-rustdocgen::directives::DirectiveOption::NoIndex
sphinx-rustdocgen::directives::DirectiveOption::RstOption
sphinx-rustdocgen::directives::DirectiveOption::RstOption::get_rst_text
sphinx-rustdocgen::directives::DirectiveOption::Sig
sphinx-rustdocgen::directives::DirectiveOption::Toc
sphinx-rustdocgen::directives::DirectiveOption::Type
sphinx-rustdocgen::directives::DirectiveOption::Vis
sphinx-rustdocgen::directives::DirectiveVisibility
,
[1]
sphinx-rustdocgen::directives::DirectiveVisibility::Crate
sphinx-rustdocgen::directives::DirectiveVisibility::Display
sphinx-rustdocgen::directives::DirectiveVisibility::Display::fmt
sphinx-rustdocgen::directives::DirectiveVisibility::effective_visibility
sphinx-rustdocgen::directives::DirectiveVisibility::FromStr
sphinx-rustdocgen::directives::DirectiveVisibility::FromStr::Err
sphinx-rustdocgen::directives::DirectiveVisibility::FromStr::from_str
sphinx-rustdocgen::directives::DirectiveVisibility::Pub
sphinx-rustdocgen::directives::DirectiveVisibility::Pvt
sphinx-rustdocgen::directives::enum_directive
sphinx-rustdocgen::directives::enum_directive::EnumDirective
,
[1]
sphinx-rustdocgen::directives::enum_directive::EnumDirective::content
sphinx-rustdocgen::directives::enum_directive::EnumDirective::from_item
sphinx-rustdocgen::directives::enum_directive::EnumDirective::MdDirective
sphinx-rustdocgen::directives::enum_directive::EnumDirective::MdDirective::fence_size
sphinx-rustdocgen::directives::enum_directive::EnumDirective::MdDirective::get_md_text
sphinx-rustdocgen::directives::enum_directive::EnumDirective::name
sphinx-rustdocgen::directives::enum_directive::EnumDirective::options
sphinx-rustdocgen::directives::enum_directive::EnumDirective::RstDirective
sphinx-rustdocgen::directives::enum_directive::EnumDirective::RstDirective::get_rst_text
sphinx-rustdocgen::directives::enum_directive::EnumDirective::variants
sphinx-rustdocgen::directives::extract_doc_from_attrs
sphinx-rustdocgen::directives::function_directive
sphinx-rustdocgen::directives::function_directive::func_from_item
sphinx-rustdocgen::directives::function_directive::FunctionDirective
,
[1]
sphinx-rustdocgen::directives::function_directive::FunctionDirective::content
sphinx-rustdocgen::directives::function_directive::FunctionDirective::from_impl_item
sphinx-rustdocgen::directives::function_directive::FunctionDirective::from_item
sphinx-rustdocgen::directives::function_directive::FunctionDirective::from_trait_item
sphinx-rustdocgen::directives::function_directive::FunctionDirective::MdDirective
sphinx-rustdocgen::directives::function_directive::FunctionDirective::MdDirective::get_md_text
sphinx-rustdocgen::directives::function_directive::FunctionDirective::name
sphinx-rustdocgen::directives::function_directive::FunctionDirective::options
sphinx-rustdocgen::directives::function_directive::FunctionDirective::RstDirective
sphinx-rustdocgen::directives::function_directive::FunctionDirective::RstDirective::get_rst_text
sphinx-rustdocgen::directives::impl_directive
sphinx-rustdocgen::directives::impl_directive::ImplDirective
,
[1]
sphinx-rustdocgen::directives::impl_directive::ImplDirective::content
sphinx-rustdocgen::directives::impl_directive::ImplDirective::from_item
sphinx-rustdocgen::directives::impl_directive::ImplDirective::items
sphinx-rustdocgen::directives::impl_directive::ImplDirective::MdDirective
sphinx-rustdocgen::directives::impl_directive::ImplDirective::MdDirective::fence_size
sphinx-rustdocgen::directives::impl_directive::ImplDirective::MdDirective::get_md_text
sphinx-rustdocgen::directives::impl_directive::ImplDirective::name
sphinx-rustdocgen::directives::impl_directive::ImplDirective::options
sphinx-rustdocgen::directives::impl_directive::ImplDirective::RstDirective
sphinx-rustdocgen::directives::impl_directive::ImplDirective::RstDirective::get_rst_text
sphinx-rustdocgen::directives::macro_directive
sphinx-rustdocgen::directives::macro_directive::MacroDirective
,
[1]
sphinx-rustdocgen::directives::macro_directive::MacroDirective::content
sphinx-rustdocgen::directives::macro_directive::MacroDirective::from_item
sphinx-rustdocgen::directives::macro_directive::MacroDirective::MdDirective
sphinx-rustdocgen::directives::macro_directive::MacroDirective::MdDirective::get_md_text
sphinx-rustdocgen::directives::macro_directive::MacroDirective::name
sphinx-rustdocgen::directives::macro_directive::MacroDirective::options
sphinx-rustdocgen::directives::macro_directive::MacroDirective::RstDirective
sphinx-rustdocgen::directives::macro_directive::MacroDirective::RstDirective::get_rst_text
sphinx-rustdocgen::directives::module_directive
sphinx-rustdocgen::directives::module_directive::is_test_module
sphinx-rustdocgen::directives::module_directive::ModuleDirective
,
[1]
sphinx-rustdocgen::directives::module_directive::ModuleDirective::content
sphinx-rustdocgen::directives::module_directive::ModuleDirective::from_item
sphinx-rustdocgen::directives::module_directive::ModuleDirective::ident
sphinx-rustdocgen::directives::module_directive::ModuleDirective::items
sphinx-rustdocgen::directives::module_directive::ModuleDirective::MdDirective
sphinx-rustdocgen::directives::module_directive::ModuleDirective::MdDirective::fence_size
sphinx-rustdocgen::directives::module_directive::ModuleDirective::MdDirective::get_md_text
sphinx-rustdocgen::directives::module_directive::ModuleDirective::name
sphinx-rustdocgen::directives::module_directive::ModuleDirective::new
sphinx-rustdocgen::directives::module_directive::ModuleDirective::options
sphinx-rustdocgen::directives::module_directive::ModuleDirective::RstDirective
sphinx-rustdocgen::directives::module_directive::ModuleDirective::RstDirective::get_rst_text
sphinx-rustdocgen::directives::module_directive::ModuleDirective::visibility
sphinx-rustdocgen::directives::order_items
sphinx-rustdocgen::directives::push_sorted
sphinx-rustdocgen::directives::struct_directive
sphinx-rustdocgen::directives::struct_directive::make_sig
sphinx-rustdocgen::directives::struct_directive::StructDirective
,
[1]
sphinx-rustdocgen::directives::struct_directive::StructDirective::content
sphinx-rustdocgen::directives::struct_directive::StructDirective::fields
sphinx-rustdocgen::directives::struct_directive::StructDirective::from_item
sphinx-rustdocgen::directives::struct_directive::StructDirective::from_variant
sphinx-rustdocgen::directives::struct_directive::StructDirective::MdDirective
sphinx-rustdocgen::directives::struct_directive::StructDirective::MdDirective::fence_size
sphinx-rustdocgen::directives::struct_directive::StructDirective::MdDirective::get_md_text
sphinx-rustdocgen::directives::struct_directive::StructDirective::name
sphinx-rustdocgen::directives::struct_directive::StructDirective::options
sphinx-rustdocgen::directives::struct_directive::StructDirective::RstDirective
sphinx-rustdocgen::directives::struct_directive::StructDirective::RstDirective::get_rst_text
sphinx-rustdocgen::directives::trait_directive
sphinx-rustdocgen::directives::trait_directive::TraitDirective
,
[1]
sphinx-rustdocgen::directives::trait_directive::TraitDirective::content
sphinx-rustdocgen::directives::trait_directive::TraitDirective::from_alias
sphinx-rustdocgen::directives::trait_directive::TraitDirective::from_item
sphinx-rustdocgen::directives::trait_directive::TraitDirective::items
sphinx-rustdocgen::directives::trait_directive::TraitDirective::MdDirective
sphinx-rustdocgen::directives::trait_directive::TraitDirective::MdDirective::fence_size
sphinx-rustdocgen::directives::trait_directive::TraitDirective::MdDirective::get_md_text
sphinx-rustdocgen::directives::trait_directive::TraitDirective::name
sphinx-rustdocgen::directives::trait_directive::TraitDirective::options
sphinx-rustdocgen::directives::trait_directive::TraitDirective::RstDirective
sphinx-rustdocgen::directives::trait_directive::TraitDirective::RstDirective::get_rst_text
sphinx-rustdocgen::directives::type_directive
sphinx-rustdocgen::directives::type_directive::type_from_item
sphinx-rustdocgen::directives::type_directive::TypeDirective
,
[1]
sphinx-rustdocgen::directives::type_directive::TypeDirective::content
sphinx-rustdocgen::directives::type_directive::TypeDirective::from_impl_item
sphinx-rustdocgen::directives::type_directive::TypeDirective::from_item
sphinx-rustdocgen::directives::type_directive::TypeDirective::from_trait_item
sphinx-rustdocgen::directives::type_directive::TypeDirective::MdDirective
sphinx-rustdocgen::directives::type_directive::TypeDirective::MdDirective::get_md_text
sphinx-rustdocgen::directives::type_directive::TypeDirective::name
sphinx-rustdocgen::directives::type_directive::TypeDirective::options
sphinx-rustdocgen::directives::type_directive::TypeDirective::RstDirective
sphinx-rustdocgen::directives::type_directive::TypeDirective::RstDirective::get_rst_text
sphinx-rustdocgen::directives::variable_directive
sphinx-rustdocgen::directives::variable_directive::var_from_item
sphinx-rustdocgen::directives::variable_directive::VariableDirective
,
[1]
sphinx-rustdocgen::directives::variable_directive::VariableDirective::content
sphinx-rustdocgen::directives::variable_directive::VariableDirective::from_const
sphinx-rustdocgen::directives::variable_directive::VariableDirective::from_fields
sphinx-rustdocgen::directives::variable_directive::VariableDirective::from_impl_const
sphinx-rustdocgen::directives::variable_directive::VariableDirective::from_static
sphinx-rustdocgen::directives::variable_directive::VariableDirective::from_trait_const
sphinx-rustdocgen::directives::variable_directive::VariableDirective::MdDirective
sphinx-rustdocgen::directives::variable_directive::VariableDirective::MdDirective::get_md_text
sphinx-rustdocgen::directives::variable_directive::VariableDirective::name
sphinx-rustdocgen::directives::variable_directive::VariableDirective::options
sphinx-rustdocgen::directives::variable_directive::VariableDirective::RstDirective
sphinx-rustdocgen::directives::variable_directive::VariableDirective::RstDirective::get_rst_text
sphinx-rustdocgen::directives::visibility_to_inherit
sphinx-rustdocgen::FileType
sphinx-rustdocgen::FileType::Bin
sphinx-rustdocgen::FileType::Lib
sphinx-rustdocgen::FileType::Mod
sphinx-rustdocgen::find_mod_file
sphinx-rustdocgen::formats
sphinx-rustdocgen::formats::Format
,
[1]
sphinx-rustdocgen::formats::Format::extension
sphinx-rustdocgen::formats::Format::format_content
sphinx-rustdocgen::formats::Format::format_directive
sphinx-rustdocgen::formats::Format::FromStr
sphinx-rustdocgen::formats::Format::FromStr::Err
sphinx-rustdocgen::formats::Format::FromStr::from_str
sphinx-rustdocgen::formats::Format::make_title
sphinx-rustdocgen::formats::Format::Md
sphinx-rustdocgen::formats::Format::MD_VALUES
sphinx-rustdocgen::formats::Format::Rst
sphinx-rustdocgen::formats::Format::RST_VALUES
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_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::INDENT
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_section
sphinx-rustdocgen::formats::RstDirective::make_rst_toctree
sphinx-rustdocgen::formats::RstOption
sphinx-rustdocgen::formats::RstOption::get_rst_text
sphinx-rustdocgen::formats::T::MdContent
sphinx-rustdocgen::formats::T::MdContent::get_md_text
sphinx-rustdocgen::formats::T::RstContent
sphinx-rustdocgen::formats::T::RstContent::get_rst_text
sphinx-rustdocgen::get_doc_file_from_path
sphinx-rustdocgen::push_module_files
sphinx-rustdocgen::read_rs_file
sphinx-rustdocgen::traverse_crate
sphinxcontrib_rust
module
sphinxcontrib_rust.directives
module
sphinxcontrib_rust.domain
module
sphinxcontrib_rust.index
module
sphinxcontrib_rust.items
module
SphinxIndexEntryType (class in sphinxcontrib_rust.items)
StructIndex (class in sphinxcontrib_rust.index)
T
TraitIndex (class in sphinxcontrib_rust.index)
TypeIndex (class in sphinxcontrib_rust.index)
V
VariableIndex (class in sphinxcontrib_rust.index)