Skip to content

Commit

Permalink
Adding make documentation instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
bjherger committed May 26, 2018
1 parent b91f92f commit dbd300c
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,16 +159,24 @@ The best bug reports are Pull Requests. The second best bug reports are new issu

This framework uses `unittest` for unit testing. Tests can be run by calling:



```bash
cd tests/

python -m unittest discover -s . -t .
```

### Style guide

This codebase should follow [Google's Python Style Guide](https://google.github.io/styleguide/pyguide.html).

### Generating documentation

This codebase uses [sphinx](http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html)'s
[autodoc](http://www.sphinx-doc.org/en/master/ext/autodoc.html) feature. To generate new documentation, to reflect
updated documentation, run:

```bash
cd docs

make html

```

0 comments on commit dbd300c

Please sign in to comment.