sphinx-rustdocgen documentation

The sphinx-rustdocgen crate consists of an executable, sphinx-rustdocgen and a supporting library crate.

• Crate sphinx-rustdocgen
  • mod directives
    • mod crate_directive
    • mod enum_directive
    • mod executable_directive
    • mod foreign_mod
    • mod function_directive
    • mod impl_directive
    • mod macro_directive
    • mod module_directive
    • mod struct_directive
    • mod trait_directive
    • mod type_directive
    • mod use_directive
    • mod variable_directive
    • type DocStructure
    • macro check_visibility
    • macro push_sorted
    • macro visibility_to_inherit
    • fn extract_doc_from_attrs
    • fn order_items
    • enum Directive
    • enum DirectiveOption
    • enum DirectiveVisibility
    • enum IndexEntryType
    • impl Directive
    • impl DirectiveVisibility
  • mod formats
    • fn generate_decoration
    • trait MdContent
    • trait MdDirective
    • trait MdOption
    • trait RstContent
    • trait RstDirective
    • trait RstOption
    • enum Format
    • impl Format
    • impl MdContent for T
    • impl RstContent for T
  • mod nodes
    • fn nodes_for_abi_opt
    • fn nodes_for_angle_bracket_generic_args
    • fn nodes_for_bare_fn
    • fn nodes_for_bound_lifetimes
    • fn nodes_for_expr_lit
    • fn nodes_for_generic_argument
    • fn nodes_for_generic_param
    • fn nodes_for_generics
    • fn nodes_for_lifetime_param
    • fn nodes_for_parenthesized_generic_args
    • fn nodes_for_pat
    • fn nodes_for_pat_type
    • fn nodes_for_path
    • fn nodes_for_path_segment
    • fn nodes_for_return_type
    • fn nodes_for_type
    • fn nodes_for_type_param
    • fn nodes_for_type_param_bound
    • fn nodes_for_type_param_bounds
    • fn nodes_for_where_clause
    • fn type_name
    • fn type_param_bound_name
    • enum Node
  • macro push_module_files
  • fn find_mod_file
  • fn find_mod_file_under
  • fn traverse_crate
  • enum FileType
    • Bin
    • Lib
    • Mod
  • struct Configuration
    • crate_name
    • src_dir
    • doc_dir
    • force
    • format
    • visibility
  • impl Configuration
    • fn canonicalize
    • fn get_doc_file_name