Skip to main content

doc2mds: Convert docstring to markdown files

Project description

doc2mds

doc2mds: Convert docstring to markdown files

This is a tool to convert docstrings of a file to markdown files.

An example is the documents for Xponge

Another example is doc2mds itself

Usage:

cd /your/package/parent/folder
mkdir _doc
cd _doc
python -m doc2mds package_name _doc

Project details


Release history Release notifications | RSS feed

This version

1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

doc2mds-1.0.tar.gz (3.8 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page