Python to MD documentation generator
Project description
docpy
This package auto-generates Markdown documentation from Python files.
Installation
This package is installed using pip:
pip install docpy
Usage
This package is used from the command line:
docpy ...
The package help entry is given below.
usage: docpy [-h] [-a APPEND] [-o OUT] [-s SUB] [-t TEMP] ...
generate Markdown documentation for Python files
positional arguments:
files files to be documented
optional arguments:
-h, --help show this help message and exit
-a APPEND, --append APPEND
file to which to append generated Markdown
-o OUT, --output OUT file to save generated Markdown to
-s SUB, --sub SUB file with ::DOCUMENTATION:: tag to replace Markdown
-t TEMP, --template TEMP
template file with ::DOCUMENTATION:: tag, needs OUT
argument
Templates
You can define a Markdown template in which your documentation will be placed using the -t
flag, which must be used in conjunction with the -o
flag. In your template, just put ::DOCUMENTATION::
where you want the documentation to be placed. For example,
# This is a markdown file.
My docs are below:
::DOCUMENTATION::
_this concludes the documentation._
Changelog
v0.1.1:
- Fixed formatting error in docstrings
v0.1.0:
- Initial release
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
docpy-0.1.1.tar.gz
(3.6 kB
view hashes)
Built Distribution
docpy-0.1.1-py3-none-any.whl
(5.1 kB
view hashes)