Skip to content

include instructions to preview changes in CONTRIB #744

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 31, 2016
Merged

include instructions to preview changes in CONTRIB #744

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,28 @@ see:

http://docs.python-guide.org/en/latest/notes/contribute/

How to test your changes
------------------------

The html version of this guide is built with [sphinx](http://www.sphinx-doc.org/en/stable/). You may test your revisions locally by having sphinx installed. You can do this easily with pip (as described in the link).

``` bash
pip install --user sphinx
```

Then navigate to the directory of the makefile and ```make build``` or ```make html```. Sphinx will then generate the html in a folder called _build/html

After navigating to this folder, you can then use python's built in webserver to view your changes locally:

``` bash
python3 -m http.server
```

By default, http.server listens on every ip address bound on your host on port 8000. To bind to a specific one, say, localhost on port 8005:

``` bash
python3 -m http.server 8005 --bind 127.0.0.1
```

Style Guide
-----------
Expand Down