Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

Lightweight docstring to markdown converter

Project Description

Very lightweight docstring to Markdown converter.


Copyright © 2013 Thomas Gläßle

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.


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

Its purpose is to quickly generate files for small projects.


The interface consists of the following functions:

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

You can run this script from the command line like:

$ [-a] [--no-toc] [-t title] module-name [class-name] >


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.

Release History

This version
History Node


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
(4.6 kB) Copy SHA256 Hash SHA256
Source None Sep 16, 2013

Supported By

Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Kabu Creative Kabu Creative UX & Design Google Google Cloud Servers Fastly Fastly CDN StatusPage StatusPage Statuspage DigiCert DigiCert EV Certificate