Skip to content
Documentation of the Open Civic Data API
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
.gitignore
LICENSE
README.md
requirements.txt

README.md

ocd-api-documentation

Documentation of the Open Civic Data API. Available on readthedocs.io.

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 ocd-api-documentation
git clone git@github.com:datamade/ocd-api-documentation.git
cd ocd-api-documentation
pip install -r requirements.txt

Afterwards, whenever you want to use this virtual environment, run workon ocd-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
  • Jack Corrigan
You can’t perform that action at this time.