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

• Initial version