Generate a markfown reference from your public API docstrings and add it to your readme
Project description
referencer-py
Generate a markdown reference from your public API docstrings and adds it to your readme.
Features
- Uses
pydoc-markdown
under the hood
Installation
The package uses semantic versioning. It means that major versions could include breaking changes.
$ pip install referencer
Documentation
referencer package README.md --in-place
Reference
cli
cli(package, document, **options)
Command-line interface
generate_document
generate_document(package, document, package_pattern='from \\.(\\w+) import (\\w+)', document_section='## Reference')
Generate document
generate_reference
generate_reference(package, package_pattern='from \\.(\\w+) import (\\w+)')
Generate reference
Contributing
virtualenv .python -ppython3.7
source .python/bin/activate
make install
make test
Changelog
v0.1
- Initial version
Project details
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
referencer-0.1.0.tar.gz
(5.2 kB
view hashes)
Built Distribution
Close
Hashes for referencer-0.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 42b3639a158b9e7b629b64fc2d2868a866c28f59c033a05f1beb2d4e74a93577 |
|
MD5 | 518174fec1d51428d96d6dee6b8d7381 |
|
BLAKE2b-256 | 2d67a8b11f1e61ea3c1a092cf7fbe280524c307cd1ce01c4117f3b3c6dd41272 |