Skip to main content

Generate a markfown reference from your public API docstrings and add it to your readme

Project description

referencer-py

Travis Coveralls PyPi Github

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


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.2.tar.gz (5.2 kB view hashes)

Uploaded Source

Built Distribution

referencer-0.1.2-py2.py3-none-any.whl (5.7 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page