Skip to content

Latest commit

 

History

History
99 lines (73 loc) · 2.21 KB

api.rst

File metadata and controls

99 lines (73 loc) · 2.21 KB
Raw

API

Structure

The following API documentation does not include all modules of autodoc_pydantic. Instead, it focuses only on modules that are relevant for documentation purposes:

autodoc_pydantic | |- __init__.py |- inspection.py <api_inspection> |- utility.py | +--directives |- __init__.py |- autodocumenters.py <api_autodocumenters> |- directives.py <api_directives> |- templates.py |- utility.py | \--options |- __init__.py |- composites.py <api_composites> |- definition.py <api_definition> |- enums.py \- validators.py

For everything else, please refer to the source code directly.

Modules

inspection.py

This module is located at sphinxcontrib/autodoc_pydantic/inspection.py.

sphinxcontrib.autodoc_pydantic.inspection

autodocumenters.py

This module is located at sphinxcontrib/autodoc_pydantic/directives/autodocumenters.py.

sphinxcontrib.autodoc_pydantic.directives.autodocumenters

definition.py

This module is located at sphinxcontrib/autodoc_pydantic/directives/options/definition.py.

sphinxcontrib.autodoc_pydantic.directives.options.definition

composites.py

This module is located at sphinxcontrib/autodoc_pydantic/directives/options/composites.py.

sphinxcontrib.autodoc_pydantic.directives.options.composites

directives.py

This module is located at sphinxcontrib/autodoc_pydantic/directives/directives.py.

sphinxcontrib.autodoc_pydantic.directives.directives