https://github.com/fboender/pydocmd

Generate Python module / script documentation in the Markdown (md) format.
https://github.com/fboender/pydocmd

Last synced: about 2 months ago
JSON representation

Generate Python module / script documentation in the Markdown (md) format.

• Host: GitHub
• URL: https://github.com/fboender/pydocmd
• Owner: fboender
• License: mit
• Created: 2015-10-25T07:23:06.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2020-07-17T06:16:55.000Z (over 4 years ago)
• Last Synced: 2024-10-10T09:33:23.072Z (2 months ago)
• Language: Python
• Size: 13.7 KB
• Stars: 5
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
pydocmd

=======

pydocmd 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.

* __Author__: Ferry Boender 

* __Version__: 0.1

* __Copyright__: Copyright 2014, Ferry Boender

* __License__: MIT (expat) License

Usage

-----

    ./pydocmd file.py > file.md

Example output

--------------

* https://github.com/fboender/pydocmd/wiki/Example-output-1

* https://github.com/fboender/pydocmd/wiki/Example-output-2

Installation

------------

Install with pip:

    pip install pydocmd