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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file doks-0.10.2.tar.gz.
File metadata
- Download URL: doks-0.10.2.tar.gz
- Upload date:
- Size: 19.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.6.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a68726d990d7e9aabaed12f6c7b9a3d30c9fa889540f087dbbfd475095a52a13
|
|
| MD5 |
58b0254fd1edf3255222b5019e06e57e
|
|
| BLAKE2b-256 |
860d49a0ce98e7fa71498a7f2bd824a30c664cefe32678bf037b3a76869f3162
|
File details
Details for the file doks-0.10.2-py3-none-any.whl.
File metadata
- Download URL: doks-0.10.2-py3-none-any.whl
- Upload date:
- Size: 18.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.6.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
92458ecc53a482fc94bfde08c16a7c2d7c44f3e5462bbad30301aa92013e54cd
|
|
| MD5 |
23b46a806ed6b425eec5dfcff8d8af57
|
|
| BLAKE2b-256 |
4b74e0769023ce87c405ab953b0e95011a81c0924abb5f7f4fe4ab469aaaa37c
|
