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 add it to your readme.
Features
- Uses
pydoc-markdown
under the hood
Getting Started
The package uses semantic versioning. It means that major versions could include breaking changes.
$ pip install referencer
Documentation
referencer package README.md --in-place
API Reference
cli
cli(package, document, **options)
Command-line interface
Usage: referencer [OPTIONS] PACKAGE DOCUMENT
Options:
--in-place [default: False]
--package-pattern TEXT [default: from \.(\w+) import (\w+)]
--document-section TEXT [default: ## Reference]
--version Show the version and exit.
--help Show this message and exit.
generate_document
generate_document(package, document, package_pattern='from \\.(\\w+) import (\\w+)', document_section='## API 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.2.1.tar.gz
(6.0 kB
view hashes)
Built Distribution
Close
Hashes for referencer-0.2.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7eacb5652aabf77fd4979054d0f55869f26bb6c27a2e0051b900dee54ce696b4 |
|
MD5 | 2f00ae4420ba1114286af9a5728fc2d3 |
|
BLAKE2b-256 | 9284e40b8f6b9381cedb9b5e5f5e528c59412343de1e2f99fd45186ffcab0b6f |