Electricmonk

Ferry Boender

Programmer, DevOpper, Open Source enthusiast.

Blog

Pydocmd: Generate Markdown from python source files

Sunday, October 5th, 2014

I’ve created pydocmd. It generates Python Module / script documentation in the Markdown (md) format. It was written to automatically generate documentation that can be put on Github or Bitbucket.

It is as of yet not very complete and is more of a Proof-of-concept than a fully-fledged tool. Markdown is also a very restricted format and every implementation works subtly, or completely, different. This means output may be different on different converters. The Bitbucket version doesn’t look as nice as the Github version.

Get it from bitbucket.

Example outputs are available:

The text of all posts on this blog, unless specificly mentioned otherwise, are licensed under this license.