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 details)

Uploaded Source

File details

Details for the file doc2mds-1.0.tar.gz.

File metadata

  • Download URL: doc2mds-1.0.tar.gz
  • Upload date:
  • Size: 3.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.0

File hashes

Hashes for doc2mds-1.0.tar.gz
Algorithm Hash digest
SHA256 45ba9cc992c0fc12bddad354e5325596b30682b296937570222912872310fcc0
MD5 933fc40b80ddc8b1b99a27a662f6ac0a
BLAKE2b-256 e28767ba1b608a2cca4f1c5511c44e8724009473aae36a058b6af2a2e752b138

See more details on using hashes here.

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