Skip to main content

Lightweight docstring to markdown converter

Project description

Very lightweight docstring to Markdown converter.

License

Copyright © 2013 Thomas Gläßle t_glaessle@gmx.de

This work is free. You can redistribute it and/or modify it under the terms of the Do What The Fuck You Want To Public License, Version 2, as published by Sam Hocevar. See the COPYING file for more details.

This program is free software. It comes without any warranty, to the extent permitted by applicable law.

Description

Little convenience tool to extract docstrings from a module or class and convert them to GitHub Flavoured Markdown:

https://help.github.com/articles/github-flavored-markdown

Its purpose is to quickly generate README.md files for small projects.

API

The interface consists of the following functions:

  • doctrim(docstring)
  • doc2md(docstring, title)

You can run this script from the command line like:

$ doc2md.py [-a] [--no-toc] [-t title] module-name [class-name] > README.md

Limitations

At the moment this is suited only for a very specific use case. It is hardly forseeable, if I will decide to improve on it in the near future.

Project details


Release history Release notifications

This version
History Node

0.1.0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
doc2md-0.1.0.tar.gz (4.6 kB) Copy SHA256 hash SHA256 Source None Sep 16, 2013

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page