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.1.tar.gz
(5.2 kB
view hashes)
Built Distribution
Close
Hashes for referencer-0.1.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f331d813fdba886d1bd59ed0ef99306bb102ccaa6cd5bd0b2c001d433ed4e427 |
|
MD5 | 54c47791b3f2b2aa83bfb0ade218748e |
|
BLAKE2b-256 | 5fc5eac8604c7b00ce13cd57e487e8510709d3d840812af057553a5d8c75e9f0 |