Module docgen

Module docgen 

Source
Expand description

Documentation generation module for pyo3-stub-gen

This module handles generating Sphinx-compatible API reference documentation from the rich type metadata that pyo3-stub-gen possesses.

Re-exports§

pub use config::DocGenConfig;
pub use ir::DocPackage;

Modules§

builder
Builder for converting StubInfo to DocPackage
config
Configuration for documentation generation
default_parser
Parser for default parameter values with type reference extraction
export
Export resolution for determining which items are publicly accessible
ir
Intermediate representation for documentation generation
link
Haddock-style link resolution for documentation
render
JSON rendering and Sphinx extension embedding
types
Type expression rendering for documentation
util
Utility functions for documentation generation