Skip to main content

Create Python API documentation in Markdown format.

Project description

Pydoc-Markdown

CircleCIVersion 3.x

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.

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 integration

Installation

Install Pydoc-Markdown from PyPI:

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

Quickstart

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

What this does:

  1. Install MkDocs
  2. Create pydoc-markdown.yaml file in the current directory
  3. Render Markdown files from the Python modules/packages in your current working directory and open a browser to the live-reloading HTML page generated by MkDocs.

Copyright © 2020 Niklas Rosenstein

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-3.1.0.tar.gz (25.3 kB view hashes)

Uploaded Source

Built Distribution

pydoc_markdown-3.1.0-py3-none-any.whl (43.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page