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.
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 --bootstrap readthedocs
$ pydoc-markdown --server --open-browser
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.2.0.post1.tar.gz
(29.7 kB
view hashes)
Built Distribution
Close
Hashes for pydoc-markdown-3.2.0.post1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f01ab419d8e0a2a752f3761065a282699d7003dd208297e5ab91a7d6f6925b39 |
|
MD5 | 26a450c37c7b636dd87699470064e3f2 |
|
BLAKE2b-256 | e6537ec8a9080f2aedb1932f92d998ca2d0a8b469a58c4ebd89224817f48bbff |
Close
Hashes for pydoc_markdown-3.2.0.post1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2d754c3df6550d89d0c6ef5fc48aa17ba33b5e45f41e77ea451dcd14e1021d1b |
|
MD5 | 8644583001b987977ebc7e28d57d5708 |
|
BLAKE2b-256 | d843a5ffba5b2bd54dedfaa4d1911e5880293cfff85962736b6d63a060e9f094 |