Python versions Pypi version Build status Docs status

Pydoc-Markdown

Pydoc-Markdown is a tool and library to create Python API documentation in Markdown format based on lib2to3, allowing it to parse your Python code without executing it.

Pydoc-Markdown requires Python 3.7 or newer, however the code that you want to generate API documentation for can be for any Python version.

>> Go to the Documentation

Features

  • Understands multiple doc styles (Sphinx, Google, Pydoc-Markdown)
  • Supports assignment docstrings (#: block before or string literal after the statement)
  • Links references to other documented API objects [WIP]
  • MkDocs, Hugo and Docusaurus integration

Installation

Install Pydoc-Markdown from PyPI:

$ pipx install 'pydoc-markdown>=4.0.0,<5.0.0'

Quickstart (MkDocs)

$ pipx install mkdocs
$ pydoc-markdown --bootstrap mkdocs
$ pydoc-markdown --bootstrap readthedocs
$ pydoc-markdown --server --open

What this does:

  1. Install MkDocs
  2. Create a pydoc-markdown.yml file in the current directory
  3. Create files to render your documentation on readthedocs.org
  4. Render Markdown files from the Python modules/packages in your current working directory and run MkDocs to open a live-preview of the page.

Quickstart (Hugo)

$ pydoc-markdown --bootstrap hugo
$ pydoc-markdown --server --open

What this does:

  1. Create a pydoc-markdown.yml file in the current directory
  2. Render Markdown files from the Python modules/packages in your current working directory and run Hugo to open a live-preview of the page. If Hugo is not available on your system, it will be downloaded automatically.

Contributing to Pydoc-Markdown

All contributions are welcome! Check out the Contributing guidelines.

Questions / Need help?

Feel free to open a topic on GitHub Discussions!


Copyright © 2021 Niklas Rosenstein