Skip to content

Commit

Permalink
Add instructions in README for generating documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Ajedi32 committed Dec 3, 2018
1 parent 56d4603 commit 0614d48
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,17 @@ To play around with the API, open an instance of Echo VR with the -http flag, th
pipenv run python -i ./test.py
```

### Generate documentation

To generate documentation for the project, run the following in the project root:

```
pipenv run sphinx-build docs/source/ docs/build/
```

You can then access the built documentation by opening the generated
`docs/build/index.html` file in a web browser.

### Release process

First, update `CHANGELOG.md` and the version number in `setup.py` and `docs/source/conf.py`. Then commit, tag, and push these changes.
Expand Down

0 comments on commit 0614d48

Please sign in to comment.