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.7 or newer, however the code that you want to generate API documentation for can be for any Python version.
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:
- Install MkDocs
- Create a
pydoc-markdown.yml
file in the current directory - Create files to render your documentation on readthedocs.org
- 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:
- Create a
pydoc-markdown.yml
file in the current directory - 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
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-4.5.1.tar.gz
(38.4 kB
view hashes)
Built Distribution
Close
Hashes for pydoc_markdown-4.5.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cf0cf169dcca548bd8e772db8d1bef051cc1e01d4756aba24e3e5200762dca8d |
|
MD5 | 7ba1226cac7e8ceb97193d857bf2ecef |
|
BLAKE2b-256 | cc330d8632e2a968f45247101466c0f2242bed3151ca4799a58f5d28db75630d |