Skip to content

blasterbug/doc2md.py

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

doc2md.py Build Status

pydocmd generates Python documentation in the Markdown (md) format. It was written to automatically generate documentation that can be put on Github or Bitbucket wiki pages. It is initially based on Ferry Boender's pydocmd.

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.

  • Author: blasterbug
  • Version: 0.2b
  • License: GNU GPL V2

Usage

$ python doc2md.py module [...]

doc2md.py scans every python file (.py) given and generates the documentation in a subfolder doc.

Example output

About

Generate Python documentation in the Markdown (md) format.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages