Skip to content

Commit

Permalink
update readme with doc instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanbaumann committed Feb 4, 2018
1 parent a625e2a commit 8ec15d6
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Expand Up @@ -31,6 +31,16 @@ To run the jupiter examples,
2. `pip install jupyter`
2. `jupyter notebook`

## Documentation

Documentation is created using Sphix. View the docs [here]().

To update docs prior to a release:

`cd docs`
`sphinx-apidoc -f -o source/ ../mapboxgl/`
`make html`

## Usage

Import the mapboxgl library and helper functions to start:
Expand Down

0 comments on commit 8ec15d6

Please sign in to comment.