Dedupe.io web API documentation

Documentation for Dedupe.io web API: https://apidocs.dedupe.io

Part of the Dedupe.io cloud service and open source toolset for de-duplicating and finding fuzzy matches in your data.

Set-up

Read the Docs suggests using Sphinx, a tool to facilitate the generation of nice-looking documentation. Before you install Sphinx, you may want to set-up a virtualized development environment: learn how to set up virtualenv.

Then, run the following in your terminal:

mkvirtualenv dedupeio-web-api-doc
git clone git@github.com:dedupeio/dedupeio-web-api-doc.git
cd dedupeio-web-api-doc
pip install -r requirements.txt

Afterwards, whenever you want to use this virtual environment, run workon web-api-documentation.

Contribute

You can learn about the process of Sphinx and document creation on the Read the Docs site.

Ready to dive in? Edit the rst files in the docs directory. Then, generate the html by running the Makefile:

cd docs
make html

Then, view your code in a browser:

open _build/html/index.html

Team

Forest Gregg, DataMade
Regina Compton, DataMade
Derek Eder, DataMade

dedupeio/dedupeio-web-api-docs

Dedupe.io web API documentation

Set-up

Contribute

Team