Converts python code to markdown docs
Project description
pydoc2md
inspired by https://github.com/gbowerman/py2md
pydoc2md
is lightweight python application that generates markdown (.md
) files from a repository of .py
. The idea is to easily generate bare bones documentation for a python project by providing a list of all classes and functions, each with their docstring.
A .md
file is generated for each .py
in the input didirectoryrection or in its subfolders.
This .md
file includes all class/functions defined in the .py
with a brief description. The result is something that looks like this:
Roadmap
This package is currently under development, bugs and breaking changes are almost garuanteed. Features that will be added soon:
- output folder structure: option to save the output
md
in a folder structure mirroring that of the input package - overall table of content: table of content with an overview of all
.md
files and how they're organised - > suggest new features you'd like to see added?
Usage
using pydoc2md is very simple. From the command line:
pydoc2md project/path output/path
For instance, the .md
files in Docs where generated with
pydoc2md Github/pydoc2md/pydoc2md Github/pydoc2md/Docs
Installation
Currently you can isntall with:
pip install git+https://github.com/FedeClaudi/pydoc2md.git
though a pip installable version will be released when the project is more mature.
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
Built Distribution
Hashes for pydoc2md-0.0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b9a4efcde647ca6a207835432afa24bbfedaefb36f19e35eed28b5421e3205c2 |
|
MD5 | 4f4eec44b6766f6aad1f1f088df88ab2 |
|
BLAKE2b-256 | 2d880e7840d148f68fde2aabd7c78c923de7852232d7570139e34381d920caf6 |