Skip to content
This repository has been archived by the owner on Jan 13, 2023. It is now read-only.

Commit

Permalink
Add text to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
reginafcompton committed Jun 1, 2017
1 parent 892b55f commit 295c404
Showing 1 changed file with 39 additions and 1 deletion.
40 changes: 39 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,40 @@
# ocd-api-documentation
Documentation of the Open Civic Data API
Documentation of the Open Civic Data API. Available on [readthedocs.io](http://ocd-api-documentation.readthedocs.io/en/latest/).

## 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](http://docs.python-guide.org/en/latest/dev/virtualenvs/).

Then, run the following in your terminal:

```bash
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](http://docs.readthedocs.io/en/latest/getting_started.html).

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

```bash
cd docs
make html
```

Then, view your code in a browser:

```bash
open _build/html/index.html
```

## Team

* Forest Gregg, DataMade
* Regina Compton, DataMade
* Jack Corrigan

0 comments on commit 295c404

Please sign in to comment.