pydoc2md - pydoc2md.py

Simple script for creation python code documentation in Markdown format

$ ./pydoc2md pydoc2md > README.md

• Markdown syntax

+-- __builtin__.object
|  +-- TextDoc2Markdown(pydoc.TextDoc, __builtin__.object)
+-- pydoc.TextDoc(pydoc.Doc)
|  +-- TextDoc2Markdown(pydoc.TextDoc, __builtin__.object)

PyDoc in Markdown format

Format a string in bold

Produce text documentation for a given class object.

Produce text documentation for a data descriptor.

Produce text documentation for a given module object.

Produce text documentation for a data object.

Produce text documentation for a property.

Produce text documentation for a function or method object.

Generate documentation for an object.

Raise an exception for unimplemented types.

Render in text a class tree as returned by inspect.getclasstree().

Format an argument default value as text.

Return the location of module docs or None

Indent text by prepending a given prefix to each line.

Format a section with a given heading.

Command-line interface (looks at sys.argv to decide what to do).

0.1

Andrey Usov https://github.com/ownport/pydoc2md