Add sphinx setup instruction

This commit is contained in:
Wan Liuyang
2018-08-20 15:51:32 +08:00
parent df57bf17a8
commit 080d807552
3 changed files with 12 additions and 1 deletions
+9
View File
@@ -57,3 +57,12 @@ You can use `python -m github.tests Issue139.testCompletion --record --auth_with
PyGithub follows [pep8 Style Guide for Python Code](http://www.python.org/dev/peps/pep-0008/) except for line length.
Please check your code with [pep8 Python style guide checker](http://pypi.python.org/pypi/pep8), by running `pep8 --ignore=E501 github`.
## Build documentation locally
Note: only Python 2 is supported as of now
```
pip install -r requirements.txt
sphinx-build doc build
```
+1 -1
View File
@@ -17,7 +17,7 @@ This library enables you to manage [GitHub] resources such as repositories, user
## Install
```bash
$ pip install pygithub
$ pip install PyGithub
```
## Simple Demo
+2
View File
@@ -1,2 +1,4 @@
requests>=2.14.0
pyjwt
sphinx<1.8
sphinx-rtd-theme<0.5