Create Python API documentation in Markdown format.
Project description
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.6 or newer.
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 and Hugo 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 --bootstrap readthedocs
$ pydoc-markdown --server --open
What this does:
- Install MkDocs
- Create
pydoc-markdown.yaml
file in the current directory - 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
Release history Release notifications | RSS feed
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.4.0.tar.gz
(33.4 kB
view hashes)
Built Distribution
Close
Hashes for pydoc_markdown-3.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 208574308b7887f3dfc58959af954cc71b482628be876be00cd5ae5441e321ac |
|
MD5 | f12cbeb499b4b573f3d9d75c934d7189 |
|
BLAKE2b-256 | 295a49e5713daf7cd563ad114d0565344e3a31ecedaf16585a594a983ab4352f |