sphinx-rustdocgen documentation

sphinx-rustdocgen is an executable to extract doc comments from Rust crates. It is tightly coupled with the sphinxcontrib-rust extension and is used by it during the Sphinx build process.

Usage:

sphinx-rustdocgen <crate_name> <crate_src_dir> <output_dir> <format> \
                  <visibility>

• Crate sphinx-rustdocgen documentation
  • macro push_module_files
  • fn check_and_create_output_dir
  • fn check_crate_src_dir
  • fn find_mod_file
  • fn get_doc_file_from_path
  • fn read_rs_file
  • fn traverse_crate
  • enum FileType
    • Bin
    • Lib
    • Mod
  • mod directives
    • macro check_visibility
    • macro push_sorted
    • macro visibility_to_inherit
    • fn extract_doc_from_attrs
    • fn order_items
    • enum Directive
    • enum DirectiveOption
    • enum DirectiveVisibility
    • impl Directive
    • impl DirectiveVisibility
    • mod crate_directive
    • mod enum_directive
    • mod function_directive
    • mod impl_directive
    • mod macro_directive
    • mod module_directive
    • mod struct_directive
    • mod trait_directive
    • mod type_directive
    • mod variable_directive
  • 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