pydoc-markdown
Create Python API documentation in Markdown format.
Decision gist · record as of 2026-08-14
Yes, if you need Markdown-based API documentation for Python projects. The tool is actively maintained, has no known vulnerabilities, and low install friction. Verify that the configuration style you plan to use (YAML, pyproject.toml, or Novella) is stable for your workflow before committing to it.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.7 or later; the package you document can target any Python version.
- Low install friction with a pure-Python wheel distribution.
- Active maintenance with recent commits; the project remains functional and under active development.
License · maintenance · safety
MIT (permissive) — MIT license permits commercial and private use with minimal restrictions; you may use, modify, and distribute the package freely provided you include the original license notice.
last release 2023-06-26 (1145 days) · last repo commit 2026-08-14 · 500 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 245,261 downloads/mo, #8,736 on PyPI
Alternatives
Verify before relying
pip install pydoc-markdown
pydoc-markdown --help
# Or: pipx install pydoc-markdown- Whether the YAML and pyproject.toml configuration formats are equally maintained after the shift toward Novella integration.
- Current state of Novella integration stability and whether it is production-ready for existing workflows.
- Performance characteristics when documenting large codebases with many modules and classes.
- Time since latest release and implications for stability in production use.
What it is and what it does
Pydoc-Markdown is a command-line tool that reads Python source code and generates Markdown-formatted API documentation without executing the code. It parses docstrings in multiple styles (Sphinx, Google, Pydoc-Markdown) and converts them to properly formatted Markdown, making it useful for teams that want to keep API docs in version control alongside their source.
The tool supports configuration via YAML or pyproject.toml files and can integrate with static site generators like MkDocs and Hugo, either directly or through the Novella build backend. It understands variable docstrings through special comment syntax and generates cross-references between API objects. With 14 runtime dependencies including Jinja2, click, and docspec, it provides a complete pipeline from Python source to publishable documentation.
Use it for
- Generate API reference documentation for a Python library and commit it to version control alongside source code.
- Integrate API documentation generation into a MkDocs or Hugo site build using Novella.
- Convert existing docstrings in Sphinx or Google style to Markdown for a new documentation site.
- Document variable assignments and module-level constants using docspec comment syntax.
- Create a CI/CD step that regenerates and validates API docs on every commit.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you need Markdown-based API documentation for Python projects.
The tool is actively maintained, has no known vulnerabilities, and low install friction. Verify that the configuration style you plan to use (YAML, pyproject.toml, or Novella) is stable for your workflow before committing to it.
Install
pydoc-markdown on PyPI
Before you install
Low install friction with a pure-Python wheel distribution. Active maintenance with recent commits; the project remains functional and under active development.
Requires Python 3.7 or later; the package you document can target any Python version.
License in practice
MIT license permits commercial and private use with minimal restrictions; you may use, modify, and distribute the package freely provided you include the original license notice.
Quickstart
pip install pydoc-markdown
pydoc-markdown --help
# Or: pipx install pydoc-markdownVerify before relying
- Whether the YAML and pyproject.toml configuration formats are equally maintained after the shift toward Novella integration.
- Current state of Novella integration stability and whether it is production-ready for existing workflows.
- Performance characteristics when documenting large codebases with many modules and classes.
- Time since latest release and implications for stability in production use.
Package facts
| License | MIT permissive |
| Python support | Supports the current Python release >=3.7,<4.0 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 14 packagesPyYAMLclickdatabind.coredatabind.jsondocspecdocspec-pythondocstring-parserjinja2nr.utilrequeststomlitomli_wwatchdogyapf |
| Maintenance | Actively maintained 1,145 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 245,261 / month, #8,736 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 3 - AlphaIntended Audience :: DevelopersIntended Audience :: End Users/DesktopLicense :: OSI Approved :: MIT LicenseProgramming Language :: Python :: 3Programming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.7Programming Language :: Python :: 3.8Programming Language :: Python :: 3.9Topic :: Software Development :: Code GeneratorsTopic :: Utilities |
Evidence: pydoc_markdown-4.8.2-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “markdown documentation from docstrings”
- pydoc-markdownPydoc-Markdown parses Python source code and generates API…
- griffe2mdGenerates Markdown API documentation from Python packages using…
- docstring-to-markdownConverts Python docstrings from reStructuredText and Google format to…
Give your agent the search over MCP, or paste the wish link into any chat.
More Utilities packages
Converts domain names between Unicode and ASCII-compatible encoding (Punycode) according to IDNA 2008 and Unicode Technical Standard 46, with security validation and broader script coverage than the standard library.
Install it if you work with internationalized domain names, need to validate domains, or use HTTP clients that depend on it transitively.
Detects and normalizes text encoding from unknown or ambiguous sources, supporting all IANA character sets that Python's core library provides codecs for, with the ability to register custom codecs.
Setuptools is a Python build backend and package management tool that handles building, distributing, and installing Python packages, including support for C/C++ extension modules.
Pluggy provides a plugin system that lets you define hook specifications and register implementations to be called in sequence, enabling extensible Python applications without tight coupling.
Install it if you're building an extensible application or framework.
Pygments is a syntax highlighter that colorizes source code and text in over 500 languages and formats, outputting to HTML, LaTeX, RTF, SVG, images, or ANSI terminal sequences.
Install it if you need to display or transform source code.
Six provides utility functions to write Python code that runs on both Python 2.7 and Python 3.3+, smoothing over language differences between the two versions.
See also haystack-pydoc-tools · mkdocs · docspec-python · numpydoc · quartodoc · mkdocstrings-python-legacy · mkdocs-click · mdformat-mkdocs · pytest-markdown-docs · mkdocstrings