From 080d807552718df5179e7998cc245e3bb9ea0262 Mon Sep 17 00:00:00 2001 From: Wan Liuyang Date: Mon, 20 Aug 2018 15:51:32 +0800 Subject: [PATCH] Add sphinx setup instruction --- CONTRIBUTING.md | 9 +++++++++ README.md | 2 +- requirements.txt | 2 ++ 3 files changed, 12 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index beffb29e..f6b54044 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 +``` diff --git a/README.md b/README.md index df97cff1..a9d0e492 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/requirements.txt b/requirements.txt index 7b088c58..2e7444d8 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,4 @@ requests>=2.14.0 pyjwt +sphinx<1.8 +sphinx-rtd-theme<0.5 \ No newline at end of file