Docgen is a Python module that generates markdown documentation for Python code that adheres to Google’s style guide.
Install
pip install docgen
Usage
$ docgen -h usage: docgen [-h] [-v] [package] docgen v0.1.1 positional arguments: package the name of the package in the current directory optional arguments: -h, --help show this help message and exit -v, --version show program's version number and exit Copyright (c) 2017, Justin Willis $ docgen Generating documentation for package docgen: docgen.types docgen.util /home/bkvaluemeal/Documents/docgen/docs
License
Copyright (c) 2017, Justin Willis Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1 maintainer
Metadata
1 maintainer
Release files for docgen 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| docgen-0.1.1.tar.gz | 5.9 kB | Without provenance | Details |
Release files / docgen-0.1.1.tar.gz
| Download URL | docgen-0.1.1.tar.gz |
|---|---|
| Size | 5.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3d14d437ede6851953790634b21e8661196aecd742968935e94034f4c832f651
|
|
BLAKE2b-256 checksum How to use checksums |
a61dc65edd26d304c5d708e55d8eabf0edaae940623fe2d0e8c8dc5372a1d36f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for docgen 0.1.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
