Automatically generated READMEs
Project description
Reads the comments from your file and puts them into a servicable .rst file.
Very suitable for single-file Python libraries that want to keep the code and documentation in sync without issues
USAGE
doks my_file.py [README.rst]API
doks.doks.doks(source, target, auto=False, window=10, verbose=False)
Print documentation for a file or module
- ARGUMENTS
- source
path to the Python file or module.
- target
path to the output file or None, in which case output is printed to stdout
- auto
If true, automatically guess both source and target files
(automatically generated by doks on 2020-07-10T14:05:23.855160)
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
doks-0.10.2.tar.gz
(19.9 kB
view hashes)
Built Distribution
doks-0.10.2-py3-none-any.whl
(18.4 kB
view hashes)
