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 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for referencer, version 0.2.2
Filename, size File type Python version Upload date Hashes
Filename, size referencer-0.2.2-py2.py3-none-any.whl (6.1 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size referencer-0.2.2.tar.gz (6.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page