Skip to content

Commit 080d807

Browse files
committed
Add sphinx setup instruction
1 parent df57bf1 commit 080d807

3 files changed

Lines changed: 12 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,3 +57,12 @@ You can use `python -m github.tests Issue139.testCompletion --record --auth_with
5757

5858
PyGithub follows [pep8 Style Guide for Python Code](http://www.python.org/dev/peps/pep-0008/) except for line length.
5959
Please check your code with [pep8 Python style guide checker](http://pypi.python.org/pypi/pep8), by running `pep8 --ignore=E501 github`.
60+
61+
## Build documentation locally
62+
63+
Note: only Python 2 is supported as of now
64+
65+
```
66+
pip install -r requirements.txt
67+
sphinx-build doc build
68+
```

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This library enables you to manage [GitHub] resources such as repositories, user
1717
## Install
1818

1919
```bash
20-
$ pip install pygithub
20+
$ pip install PyGithub
2121
```
2222

2323
## Simple Demo

requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
requests>=2.14.0
22
pyjwt
3+
sphinx<1.8
4+
sphinx-rtd-theme<0.5

0 commit comments

Comments
 (0)