Metadata-Version: 2.1
Name: docpy
Version: 0.1.1
Summary: Python to MD documentation generator
Home-page: https://github.com/chrispyles/docpy
Author: Chris Pyles
Author-email: cpyles@berkeley.edu
License: BSD-3-Clause
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown

# 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,

```markdown
# 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

