Docstrings Python Packages

mkdocstrings

:blue_book: Automatic documentation from sources, for MkDocs.

pydocstyle

docstring style checker

flake8-docstrings

Integration of pydocstyle and flake8 for combined linting and reporting

pdoc

API Documentation for Python Projects

xdoctest

A rewrite of Python's builtin doctest module (with pytest plugin integration) with AST instead of RegEx.

pdoc3

🐍 ➡️ 📜 Auto-generate API documentation for Python projects

pydocstringformatter

Automatically format your Python docstrings to conform with PEP 8 and PEP 257

targ

Python CLI using type hints and docstrings.

sphinxcontrib-django

This is a sphinx extension which improves the documentation of Django apps.

pytkdocs

Load Python objects documentation.

docstring-inheritance

A python package to avoid writing and maintaining duplicated python docstrings.

griffe-inherited-docstrings

Griffe extension for inheriting docstrings.

pep257

docstring style checker

pyment

Format and convert Python docstrings and generates patches

sphinxcontrib-django2

This was a fork of sphinxcontrib-django, but all changes have been merged into the upstream repository.

documented

Templated docstrings for Python classes

pydocstring-rs

A zero-dependency Rust parser for Python docstrings (Google & NumPy) — full AST with byte-precise source locations, built for linters and formatters.

docconvert

Update or convert docstring style formats in Python code.

pystaleds

Tool to check for stale docstrings of Python projects

cltoolbox

Python utility package that wraps argparse to easily create a command line interface from a function.

python-cdd

OpenAPI ↔ Python. To/fro routes, models, and tests. Convert between docstrings, classes, methods, argparse, SQLalchemy, Pydantic, JSON-schema.

docvet

Comprehensive docstring quality vetting for Python projects

pythonbasictools

Python Basic Tools

arger

Create argparser automatically from function signatures