Index of Rust items

Crates | Enums | Executables | Functions | Macros | Modules | Structs | Traits | Types | Variables

	Crates
	crate sphinx_rustdocgen	Library for the sphinx-rustdocgen executable.
	Enums
	enum Directive (in sphinx_rustdocgen::directives)	The Sphinx directives that are implemented by the Rust domain.
	Crate
	Enum
	Executable
	Function
	Impl
	Macro
	Module
	Struct
	Trait
	Type
	Use
	Variable
	enum DirectiveOption (in sphinx_rustdocgen::directives::directive_options)	Enum to represent the various options for the directives.
	Index	The ``:index:`` option
	Layout	The ``:layout:`` option.
	Toc	The ``:toc:`` option.
	Vis	The ``:vis:`` option.
	enum DirectiveVisibility (in sphinx_rustdocgen::directives::directive_options)	Enum for the values of the :rust:struct:`DirectiveOption::Vis` option
	Crate	Crate visibility
	Pub	Public visibility
	Pvt	Private visibility
	enum IndexEntryType (in sphinx_rustdocgen::directives::directive_options)	The different index entry types.
	None
	Normal
	SubEntry
	WithSubEntries
	enum UseDirectiveOption (in sphinx_rustdocgen::directives::use_directive)	Options for the use directive.
	Reexport
	UsedName
	enum Format (in sphinx_rustdocgen::formats)	Supported formats for the docstrings
	Md	Markdown format
	Rst	reStructuredText format
	enum Node (in sphinx_rustdocgen::nodes)	Enum representing various docutils nodes for item signatures
	Indent	A node for adding an indentation before the line.
	Keyword	A node for a keyword in the signature.
	Lifetime	A node for a lifetime name. This is not a docutils node, but kept
	Link	A node for link to another item in the signature.
	Literal	A literal string to include in the signature.
	Name	The node for a name in the signature.
	Newline	A node for a newline in the signature.
	Operator	A node for an operator in the signature.
	Punctuation	A node for a punctuation in the signature.
	Returns	A node for the returns symbol.
	Space	A node for a single space in the signature.
	Executables
	sphinx-rustdocgen	sphinx-rustdocgen is an executable to extract doc comments from Rust
	Functions
	fn main (in sphinx-rustdocgen)
	fn extract_doc_from_attrs (in sphinx_rustdocgen::directives)	Extract the docstring from the attrs of an item.
	fn nodes_for_fn_signature (in sphinx_rustdocgen::directives::function_directive)	Generate docutils node layout for the function from its signature
	fn nodes_for_impl (in sphinx_rustdocgen::directives::impl_directive)	Generate docutils nodes for the impl block's signature.
	fn find_file_under_dir (in sphinx_rustdocgen::directives::module_directive)	Find the file for the module under the provided directory.
	fn has_test_token (in sphinx_rustdocgen::directives::module_directive)	Check if the module is a test module or not.
	fn order_items (in sphinx_rustdocgen::directives)	Order the items for documentation
	fn generate_decoration (in sphinx_rustdocgen::formats)	Generate title decoration string for RST or fence for MD.
	fn nodes_for_abi_opt (in sphinx_rustdocgen::nodes)	Create nodes for an optional ABI specification.
	fn nodes_for_angle_bracket_generic_args (in sphinx_rustdocgen::nodes)	Create nodes for angle bracket generic arguments in paths.
	fn nodes_for_bare_fn (in sphinx_rustdocgen::nodes)	Create nodes for a bare fn type.
	fn nodes_for_bound_lifetimes (in sphinx_rustdocgen::nodes)	Create nodes for bound lifetimes.
	fn nodes_for_expr_lit (in sphinx_rustdocgen::nodes)	Create nodes for a literal expression.
	fn nodes_for_generic_argument (in sphinx_rustdocgen::nodes)	Create nodes for a generic argument.
	fn nodes_for_generic_param (in sphinx_rustdocgen::nodes)	Create nodes for a generic parameter, along with its bounds.
	fn nodes_for_generics (in sphinx_rustdocgen::nodes)	Create nodes for generics declared for an item.
	fn nodes_for_lifetime_param (in sphinx_rustdocgen::nodes)	Create nodes for a lifetime parameter.
	fn nodes_for_parenthesized_generic_args (in sphinx_rustdocgen::nodes)	Create nodes for parenthesized generic arguments in paths.
	fn nodes_for_pat (in sphinx_rustdocgen::nodes)	Create nodes for a pattern binding.
	fn nodes_for_pat_type (in sphinx_rustdocgen::nodes)	Create nodes for a type pattern binding.
	fn nodes_for_path (in sphinx_rustdocgen::nodes)	Create nodes for a path.
	fn nodes_for_path_segment (in sphinx_rustdocgen::nodes)	Create nodes for a path segment.
	fn nodes_for_return_type (in sphinx_rustdocgen::nodes)	Create nodes for the return type of function.
	fn nodes_for_type (in sphinx_rustdocgen::nodes)	Create nodes for a type specification.
	fn nodes_for_type_param (in sphinx_rustdocgen::nodes)	Create nodes for a type parameter, along with its bounds.
	fn nodes_for_type_param_bound (in sphinx_rustdocgen::nodes)	Create nodes for a type parameter binding.
	fn nodes_for_type_param_bounds (in sphinx_rustdocgen::nodes)	Create nodes for all type parameters in a binding.
	fn nodes_for_where_clause (in sphinx_rustdocgen::nodes)	Create nodes for the where clause of generics for an item.
	fn type_name (in sphinx_rustdocgen::nodes)	Get simple name for a type.
	fn type_param_bound_name (in sphinx_rustdocgen::nodes)	Get simple name for a type parameter bound.
	fn type_path_name (in sphinx_rustdocgen::nodes)	Get simple name for a type path.
	fn traverse_crate (in sphinx_rustdocgen)	Traverse the crate and extract the docstrings for the items.
	fn check_for_manifest (in sphinx_rustdocgen::utils)	Check the provided paths for the Cargo.toml file.
	Macros
	macro func_from_item (in sphinx_rustdocgen::directives::function_directive)	DRY macro to parse the different item types.
	macro push_sorted (in sphinx_rustdocgen::directives)	Macro to sort and push items within a vec.
	macro make_nodes (in sphinx_rustdocgen::directives::struct_directive)	DRY macro to create the nodes for the directive's layout.
	macro type_from_item (in sphinx_rustdocgen::directives::type_directive)	DRY macro to create :rust:struct:`TypeDirective` from various syn structs.
	macro var_from_item (in sphinx_rustdocgen::directives::variable_directive)	DRY macro to create :rust:struct:`VariableDirective` from various ``syn``
	Modules
	module directives (in sphinx_rustdocgen)	Module for the various Sphinx directives for the Rust domain.
	module crate_directive (in sphinx_rustdocgen::directives)	Implementation of the ``rust:crate`` directive.
	module directive_options (in sphinx_rustdocgen::directives)
	module enum_directive (in sphinx_rustdocgen::directives)	Implementation of the ``rust:enum`` directive
	module executable_directive (in sphinx_rustdocgen::directives)	Implementation of the ``rust:executable`` directive.
	module function_directive (in sphinx_rustdocgen::directives)	Implementation of the ``rust:function`` directive
	module impl_directive (in sphinx_rustdocgen::directives)	Implementation of the ``rust:impl`` directive
	module macro_directive (in sphinx_rustdocgen::directives)	Implementation of the ``rust:macro`` directive
	module module_directive (in sphinx_rustdocgen::directives)	Implementation of the ``rust:module`` directive
	module struct_directive (in sphinx_rustdocgen::directives)	Implementation of the ``rust:struct`` directive
	module trait_directive (in sphinx_rustdocgen::directives)	Implementation of the ``rust:trait`` directive
	module type_directive (in sphinx_rustdocgen::directives)	Implementation of the ``rust:type`` directive
	module use_directive (in sphinx_rustdocgen::directives)
	module variable_directive (in sphinx_rustdocgen::directives)	Implementation of the ``rust:variable`` directive
	module formats (in sphinx_rustdocgen)	Module for handling the output formats supported.
	module nodes (in sphinx_rustdocgen)	Module for generating a semi-structured representation of Rust signatures.
	module utils (in sphinx_rustdocgen)	Module for various utility classes and structs.
	Structs
	struct Configuration (in sphinx_rustdocgen)	Struct to hold the deserialized configuration passed from Python.
	crate_dir	The directory containing the Cargo.toml file for the crate.
	crate_name	The name of the crate.
	doc_dir	The directory under which to create the crate's documentation.
	force	Rebuild document for all files, even if it has not changed.
	format	The format to use for the output.
	strip_src	Whether to remove the src/ directory when generating the docs or not.
	visibility	The required visibility of the items to include.
	struct RuntimeConfiguration (in sphinx_rustdocgen)	Runtime version of the configuration after validation and normalizing.
	crate_dir	The crate's root directory, the one which contains ``Cargo.toml``.
	crate_name	The name of the crate in the configuration.
	doc_dir	The directory under which to write the documents.
	executables	The executables within the crate that will be documented.
	force	Whether to rewrite all the documents, even the ones that are unchanged.
	format	The format of the docstrings.
	lib	The crate's library to document, if any.
	max_visibility	Only document items with visibility less than this.
	src_dir	The crate's src/ directory, if one is found and ``strip_src`` is true.
	struct FileDirectives (in sphinx_rustdocgen::directives)
	impls	The directives for the impls defined in the file.
	items	The directives for all other items in the file.
	modules	The directives for the modules defined in the file.
	uses	The directives for the use statements in the file.
	struct CrateDirective (in sphinx_rustdocgen::directives::crate_directive)	Struct to hold data required for documenting a crate.
	content	The docstring for the crate's lib.rs file.
	doc_file	The path to directive's documentation file
	file_directives	The directives within the crate's document file.
	name	The name of the crate.
	options	The options for the crate directive.
	struct EnumDirective (in sphinx_rustdocgen::directives::enum_directive)	Struct to hold data for documenting an enum
	content	The docstring for the enum.
	ident	The identifier for the enum.
	name	The full Rust path of the enum, used as the name of the directive.
	options	The directive options to use.
	self_impls	Items within impl blocks for the enum.
	trait_impls	Trait impls for the enum.
	variants	The variants within the enum.
	struct ExecutableDirective (in sphinx_rustdocgen::directives::executable_directive)	Struct to hold data required for documenting an executable.
	struct FunctionDirective (in sphinx_rustdocgen::directives::function_directive)	Struct to hold data for documenting a function.
	content	The docstring for the function.
	ident	The identifier of the function.
	name	The full Rust path of the function.
	options	The directive options to use.
	struct ImplDirective (in sphinx_rustdocgen::directives::impl_directive)	Struct to hold details for documenting an impl block.
	content	The content for the directive.
	items	The directives nested under this directive.
	name	The full Rust path to the impl block, used as the directive's name.
	options	The options for the directive.
	resolved_self_ty	The full path of the self type of the impl block.
	resolved_trait	The full path of the trait implemented, if any.
	self_ty	The declared self type of the impl block.
	trait_	The trait implemented in the impl block, if any.
	struct MacroDirective (in sphinx_rustdocgen::directives::macro_directive)
	content
	ident
	name
	options
	struct ModuleAttrs (in sphinx_rustdocgen::directives::module_directive)	Module attributes
	is_test	Whether the module is a test module or not
	path	Path to the module
	struct ModuleDirective (in sphinx_rustdocgen::directives::module_directive)	Struct to hold data for a module's documentation.
	content	The docstring for the module.
	doc_file	The path to directive's documentation file
	file_directives	The directives within the crate's document file.
	ident	The identifier of the module (i.e. the final portion of name).
	name	The full path to the module.
	options	The options for the module directive.
	source_code_file	The source code file for the module.
	struct StructDirective (in sphinx_rustdocgen::directives::struct_directive)	Struct to hold details for documenting a struct or a union.
	content	The docstring for the struct.
	fields	The fields of the struct, named or unnamed.
	ident	The identifier for the struct.
	name	The full Rust path of the struct, used as the name of the directive.
	options	The directive options to use.
	self_impls	Items within impl blocks for the struct/union.
	trait_impls	Trait impls for the struct/union.
	struct TraitDirective (in sphinx_rustdocgen::directives::trait_directive)	Struct to hold details for documenting a trait.
	content	The docstring for the trait.
	ident	The identifier for the trait.
	impls	Generic impls of the trait.
	items	Items within the trait.
	name	The full Rust path of the trait, used as the name of the directive.
	options	The directive options to use.
	struct TypeDirective (in sphinx_rustdocgen::directives::type_directive)	Struct to hold the data for documenting type definitions.
	content	The content of the directive.
	ident	The identifier of the type.
	name	The Rust path of the type.
	options	The options of the directive.
	struct UseDirective (in sphinx_rustdocgen::directives::use_directive)
	content
	directive_visibility
	paths
	reexport
	struct UsePathBuilder (in sphinx_rustdocgen::directives::use_directive)
	path
	used_name
	struct VariableDirective (in sphinx_rustdocgen::directives::variable_directive)	Struct to hold the data for documenting variables and struct fields.
	content	The content of the directive.
	ident	The identifier of the variable or field.
	name	The Rust path of the variable or field.
	options	The options for the directive.
	struct CargoManifest (in sphinx_rustdocgen::utils)	Newtype struct for the Cargo manifest from cargo_toml.
	struct SourceCodeFile (in sphinx_rustdocgen::utils)	Struct for the source code files encountered when scanning the crate.
	item	The name of the item in the file.
	path	The path to the file.
	Traits
	trait MdContent (in sphinx_rustdocgen::formats)	Trait for anything that can be converted to MD directive content.
	fn get_md_text
	trait MdDirective (in sphinx_rustdocgen::formats)	Trait for directives that can be written as MD content
	fn calc_fence_size	Calculate the fence size required for the item.
	fn fence_size	Return the fence size required for documenting the item.
	fn get_md_text	Generate MD text with the given fence size.
	fn make_fence	Make a string for the fences for the directive.
	fn make_md_header	Make the MD directive header from the directive, name and options.
	fn make_md_list	Make an MD list of items.
	fn make_md_section	Make section in an MD document with the given title and items.
	fn make_md_toctree	Make a ``toctree`` directive for MD documents.
	trait MdOption (in sphinx_rustdocgen::formats)	Trait for MD directive options
	fn get_md_text	Return the MD text for the option.
	trait RstContent (in sphinx_rustdocgen::formats)	Trait for anything that can be converted to RST directive content.
	fn get_rst_text
	trait RstDirective (in sphinx_rustdocgen::formats)	Trait for directives that can be written as RST content
	fn get_rst_text	Generate RST text with the given level of indentation.
	fn make_content_indent	Make a string for indenting the directive's content and options
	fn make_indent	Make a string for indenting the directive.
	fn make_rst_header	Make the RST directive header from the directive, name and options.
	fn make_rst_list	Make an RST list of items.
	fn make_rst_section	Make section in an RST document with the given title and items.
	fn make_rst_toctree	Make a ``toctree`` directive for RST documents.
	trait RstOption (in sphinx_rustdocgen::formats)	Trait for RST directive options.
	fn get_rst_text	Return the RST text for the option.
	trait FileTopLevelDirective (in sphinx_rustdocgen::utils)
	fn get_doc_file
	fn get_text
	Types
	type ItemSections (in sphinx_rustdocgen::directives)	Named type for the output of :rust:fn:`order_items`.
	Variables
	const USAGE (in sphinx-rustdocgen)