dynadoc¶
📝 A Python library package which bridges the gap between rich annotations and automatic documentation generation with configurable renderers and support for reusable fragments.
Key Features ⭐¶
🔄 Docstring Generation: Generation of docstrings for modules, classes, functions, and methods via introspection with fine-grained control.
🧩 Fragment System: Reusable documentation snippets for consistent terminology across projects.
🏷️ Annotation Metadata: Extraction and inclusion of metadata from annotations into generated docstrings.
🔌 Extensible Architecture: Custom renderers, attribute visibility rules, and introspection limiters.
📖 Sphinx-Compatible Output: Render reStructuredText docstrings that work with Sphinx Autodoc out of the box.
🎨 Configurable Renderers: Ability to extend with other renderers as desired.
Installation 📦¶
Method: Install Python Package¶
Install via uv pip
command:
uv pip install dynadoc
Or, install via pip:
pip install dynadoc
Examples 💡¶
Please see the examples directory.
Function Documentation:
import dynadoc
from typing import Annotated
@dynadoc.with_docstring( )
def process_api_data(
endpoint: Annotated[ str, dynadoc.Doc( "API endpoint URL to query" ) ],
timeout: Annotated[ float, dynadoc.Doc( "Request timeout in seconds" ) ] = 30.0,
) -> Annotated[ dict, dynadoc.Doc( "Processed API response data" ) ]:
''' Process data from API endpoint with configurable timeout. '''
return { }
Which will be turned into the following docstring on the function by the default renderer:
Process data from API endpoint with configurable timeout.
:argument endpoint: API endpoint URL to query
:type endpoint: str
:argument timeout: Request timeout in seconds
:type timeout: float
:returns: Processed API response data
:rtype: dict
Module Documentation:
Document all annotated attributes in current module:
import dynadoc
dynadoc.assign_module_docstring( __name__ )
Contribution 🤝¶
Contribution to this project is welcome! However, it must follow the code of conduct for the project.
Please file bug reports and feature requests in the issue tracker or submit pull requests to improve the source code or documentation.
For development guidance and standards, please see the development guide.
More Flair¶
