Skip to main content

Embed your documentation inside runnable examples

Project description

Exemplary

A tool which provides extremely simple way to generate markdown documentation from actual source code examples!

Requirements

The requirements for using this package are:

  • Python (>= 3.8).

Installation Guide

Install the package as you would any other, using pip:

> pip install exemplary
# or use `pipx` for virtual-env isolation
> pipx install exemplary

And that's it, you're good to go.

Usage Guide

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

python-exemplary-0.0.2.tar.gz (12.9 kB view hashes)

Uploaded Source

Built Distribution

python_exemplary-0.0.2-py3-none-any.whl (9.3 kB view hashes)

Uploaded 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