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.mdLimitations
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 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
File details
Details for the file doc2md-0.1.0.tar.gz.
File metadata
- Download URL: doc2md-0.1.0.tar.gz
- Upload date:
- Size: 4.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 22b76a53256077dcbac539731f806f90439a0bd564bd4879513968cbe97bb6d8 |
|
| MD5 | 1fabff4ebe5e45dd8997e96b3c650e51 |
|
| BLAKE2b-256 | 4b9136c863845e9b4afb537ca1f5be75b2751c367e35df59e0ad1a9a33d3ea2e |
