sphinxcontrib-rust
v0.3.0

Detailed docs

  • Including the docs in the Sphinx build
  • Rust specific roles
  • Rust specific directives
  • Rust items index
  • Developer Documentation
  • Limitations
  • sphinx-rustdocgen documentation
    • sphinx-rustdocgen
    • Crate sphinx-rustdocgen
  • sphinxcontrib_rust documentation
  • TODO list
  • Contributing to sphinxcontrib-rust
sphinxcontrib-rust
  • sphinx-rustdocgen documentation
  • Edit on GitLab

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 variable_directive
      • 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
    • 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
Previous Next

© Copyright 2024, Munir Contractor. Revision 5730e1ef.

Built with Sphinx using a theme provided by Read the Docs.