README

This repository contains the source files for Amperity documentation (https://docs.amperity.com). This site hosts all business user, tenant operator, and API documentation for the Amperity customer data platform.

If you'd like to help improve the documentation you can:

1. Build the documentation locally
2. Report an issue
3. Request an update
4. Suggest changes

Quick start

To build the documentation locally you'll need to install Sphinx, which is the static site generator used to build Amperity documentation. Local development requires Sphinx, a minimum version of Python, and a small collection of Python libraries, Sphinx extensions, and a makefile.

To report issues, request updates, or suggest changes without using local development, use the Edit in GitHub link located in the upper right on every Amperity documentation page to open that page in the Amperity documentation repository on GitHub.

From that page you may:

1. Report an issue
2. Request an update
3. Suggest changes