Docstring Python Packages

pdoc

API Documentation for Python Projects

docformatter

Formats docstrings to follow PEP 257

pydoclint

A very fast Python docstring linter

docsig

Check Python signature params for proper documentation

pdoc3

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

lazydocs

📖 Generate markdown API documentation from Google-style Python docstring. The lazy alternative to Sphinx.

numdoclint

Numdoc Lint provides features such as NumPy style docstring code checking.

pydocstring-rs

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

stubdoc

stubdoc is a Python library that append docstring to stub files.

sl-docformatter

Formats docstrings to follow PEP 257

epythet

Tools for documentation

mkgendocs

Markdown documentation generator from Google docstrings

doq

Docstring generator

glacier

:snowflake: Building Python CLI using docstrings and typehints :snake:

cacaodocs

CacaoDocs is a lightweight Python package that effortlessly extracts API documentation directly from your code's docstrings

agent-readable

A lightweight Python protocol and tool for agent-oriented documentation

docstringify

Flag missing docstrings and, optionally, generate them from signatures and type annotations.

mydocstring

A tool for extracting and converting Google-style docstrings to plain-text, Markdown, and JSON

doccron

Schedule with Docstrings

pygenstub

Python stub file generator.

optfunc2

Generate help tips and argument options automatically.

style-doc

Black for Python docstrings and reStructuredText (rst).

pydocfix

A Python docstring linter with auto-fix support

mikedoc

Neat docstring format for building API references