Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chrispyles/docpy
Python documentation generator
https://github.com/chrispyles/docpy
Last synced: 11 days ago
JSON representation
Python documentation generator
- Host: GitHub
- URL: https://github.com/chrispyles/docpy
- Owner: chrispyles
- License: bsd-3-clause
- Created: 2019-08-14T02:22:58.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-08-22T22:58:49.000Z (about 5 years ago)
- Last Synced: 2024-10-11T19:12:09.615Z (about 1 month ago)
- Language: Python
- Homepage:
- Size: 15.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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