https://github.com/heardacat/lazydoc
a python package to document things using sphinx without using too much effort
https://github.com/heardacat/lazydoc
Last synced: 2 months ago
JSON representation
a python package to document things using sphinx without using too much effort
- Host: GitHub
- URL: https://github.com/heardacat/lazydoc
- Owner: HeardACat
- Created: 2016-12-20T13:44:34.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-12-21T10:01:14.000Z (over 8 years ago)
- Last Synced: 2025-03-20T21:42:35.322Z (3 months ago)
- Language: Python
- Size: 8.79 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
lazydoc
=======
Sometimes when you program in multiple languages, the last thing you're going to worry about is configurations.
LazyDoc is your world to automatic documentation using Sphinx by guessing all the parameters. It works best with `d2tol`
Usage
=====
Installing using
```
python setup.py install
```
Usage is via the commandline `lazydoc`:
```
usage: lazydoc [-h] [-g] [-d]
Generate documentation - the lazy way
optional arguments:
-h, --help show this help message and exit
-g, --gen, --generate
generate sphinx doc directories
-d, --doc, --document
based on sphinx config, generate all documentation
```