Skip to content

Commit

Permalink
Updated docs with how to build docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
ericmjl committed Apr 20, 2018
1 parent f137f97 commit 182825a
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions CONTRIBUTING.rst
Expand Up @@ -70,6 +70,11 @@ Ready to contribute? Here's how to set up `nxviz` for local development.
$ cd nxviz/
$ python setup.py develop

4. (Optionally) Build the docs::

$ cd docs/
$ make html # docs will found in _build/html/. Open `index.html` to view the docs; macOS users can do `open _build/html/index.html` to open the docs in your default browser.

4. Create a branch for local development::

$ git checkout -b name-of-your-bugfix-or-feature
Expand Down

0 comments on commit 182825a

Please sign in to comment.