From a57e49d55b7d703c8e5153811d6f5de3eacd2272 Mon Sep 17 00:00:00 2001 From: harshasrinivas Date: Mon, 20 Mar 2017 19:49:31 +0530 Subject: [PATCH 1/3] Add sphinx_rtd_theme to docs setup readme --- docs/README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.rst b/docs/README.rst index 733af2af4..af8bf4297 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -15,7 +15,7 @@ and all its dependencies run :: - pip install 'Sphinx >= 1.3' + pip install 'Sphinx >= 1.3' sphinx_rtd_theme Compile the documentation From 4ec07ae7640df6fdb13a24a4265232fd11e53755 Mon Sep 17 00:00:00 2001 From: harshasrinivas Date: Mon, 20 Mar 2017 22:21:08 +0530 Subject: [PATCH 2/3] Create docs/requirements.txt --- docs/README.rst | 2 +- docs/requirements.txt | 2 ++ tox.ini | 3 +-- 3 files changed, 4 insertions(+), 3 deletions(-) create mode 100644 docs/requirements.txt diff --git a/docs/README.rst b/docs/README.rst index af8bf4297..f6011b2c6 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -15,7 +15,7 @@ and all its dependencies run :: - pip install 'Sphinx >= 1.3' sphinx_rtd_theme + pip install -r requirements.txt Compile the documentation diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 000000000..44e97ceb1 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +'Sphinx >= 1.3' +sphinx_rtd_theme \ No newline at end of file diff --git a/tox.ini b/tox.ini index bbf50b733..6987847f8 100644 --- a/tox.ini +++ b/tox.ini @@ -82,8 +82,7 @@ deps = {[testenv:py33]deps} [docs] changedir = docs deps = - Sphinx - sphinx_rtd_theme + -rdocs/requirements.txt [testenv:docs] changedir = {[docs]changedir} From 83aa0c5e1a971c07d0beab89fde91ce1184f098c Mon Sep 17 00:00:00 2001 From: harshasrinivas Date: Mon, 20 Mar 2017 22:36:09 +0530 Subject: [PATCH 3/3] Clarify docs readme --- docs/README.rst | 2 +- docs/requirements.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/README.rst b/docs/README.rst index f6011b2c6..0a343cd19 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -11,7 +11,7 @@ Setup the environment --------------------- To compile the documentation you need Sphinx Python library. To install it -and all its dependencies run +and all its dependencies run the following command from this dir :: diff --git a/docs/requirements.txt b/docs/requirements.txt index 44e97ceb1..d3dcb97be 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,2 @@ -'Sphinx >= 1.3' +Sphinx>=1.3 sphinx_rtd_theme \ No newline at end of file