Skip to main content

Create Python API documentation in Markdown format.

Project description


Python versions Pypi version Build status Gitter chat

Pydoc-Markdown is a tool to create Python API documentation in Markdown format. Instead of executing your Python code like so many other documentation tools, it parses it using docspec instead. To run Pydoc-Markdown, you need to use at least Python 3.7.

>> Go to the Documentation


I recommend to install Pydoc-Markdown using Pipx.

$ pipx install pydoc-markdown[novella]


  • Understands multiple documentation styles (Sphinx, Google, Pydoc-Markdown specific) and converts them to properly formatted Markdown
  • Can parse docstrings for variables thanks to docspec (#: block before or string literal after the statement)
  • Generates links to other API objects per the documentation syntax (e.g. #OtherClass for the Pydoc-Markdown style)


Starting with 4.6.0, development focuses on integrating with Novella and use it as a replacement for tool-specific renderers thus far provided directly by Pydoc-Markdown (i.e. integrations with MkDocs, Hugo and Docusuraus). Such integrations are/will be provided by Novella instead.

With the Novella integration, you can now place generated API content in Markdown format inline with your existing Markdown documentation source files using @pydoc tags. Check out the Documentation for more information on how to use Pydoc-Markdown with Novella.

The old style of using Pydoc-Markdown with a YAML or PyProject configuration to generate files and kick off the build is now deprecated but will be maintained for the foreseeable future (at least until the next major version bump). It is strongly recommended to migrate your existing projects to using the Novella build backend.

Contributing to Pydoc-Markdown

All contributions are welcome! Check out the Contribution Guidelines.

Questions / Need help?

Feel free to open a topic on GitHub Discussions!

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pydoc-markdown-4.6.3.tar.gz (42.0 kB view hashes)

Uploaded source

Built Distribution

pydoc_markdown-4.6.3-py3-none-any.whl (64.2 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page