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.
#:
block before or string literal after the statement)Install Pydoc-Markdown from PyPI:
$ pipx install 'pydoc-markdown>=4.0.0,<5.0.0'
$ pipx install mkdocs
$ pydoc-markdown --bootstrap mkdocs
$ pydoc-markdown --bootstrap readthedocs
$ pydoc-markdown --server --open
What this does:
pydoc-markdown.yml
file in the current directory$ pydoc-markdown --bootstrap hugo
$ pydoc-markdown --server --open
What this does:
pydoc-markdown.yml
file in the current directoryAuthor: NiklasRosenstein
The Demo/Documentation: View The Demo/Documentation
Download Link: Download The Source Code
Official Website: https://github.com/NiklasRosenstein/pydoc-markdown
#markdown #api #python