Skip to content

Commit f0867fe

Browse files
author
Ahmad Jarara
committed
include instructions to preview changes in CONTRIB
1 parent 5769917 commit f0867fe

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,28 @@ see:
66

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

9+
How to test your changes
10+
------------------------
11+
12+
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).
13+
14+
``` bash
15+
pip install --user sphinx
16+
```
17+
18+
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
19+
20+
After navigating to this folder, you can then use python's built in webserver to view your changes locally:
21+
22+
``` bash
23+
python3 -m http.server
24+
```
25+
26+
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:
27+
28+
``` bash
29+
python3 -m http.server 8005 --bind 127.0.0.1
30+
```
931

1032
Style Guide
1133
-----------

0 commit comments

Comments
 (0)