From 16ec59a72ec3dbf3386f327bce292208ffc9e134 Mon Sep 17 00:00:00 2001 From: Chris Kleinknecht Date: Fri, 28 Feb 2020 13:57:30 -0800 Subject: [PATCH 1/7] Add .readthedocs.yml --- .readthedocs.yml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 .readthedocs.yml diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000000..3dcf0e5cf6 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,14 @@ +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details +version: 2 + +sphinx: + configuration: docs/conf.py + +build: + image: latest + +python: + version: 3.8 + install: + - requirements: docs-requirements.txt From 6ccd47f6087731c28d684d92d551f4d06283215b Mon Sep 17 00:00:00 2001 From: Chris Kleinknecht Date: Fri, 28 Feb 2020 13:57:59 -0800 Subject: [PATCH 2/7] Split out docs requirements --- docs-requirements.txt | 3 +++ tox.ini | 8 +++----- 2 files changed, 6 insertions(+), 5 deletions(-) create mode 100644 docs-requirements.txt diff --git a/docs-requirements.txt b/docs-requirements.txt new file mode 100644 index 0000000000..4b654a15c8 --- /dev/null +++ b/docs-requirements.txt @@ -0,0 +1,3 @@ +sphinx~=2.1 +sphinx-rtd-theme~=0.4 +sphinx-autodoc-typehints~=1.10.2 diff --git a/tox.ini b/tox.ini index 23f8dbce05..f26f0a57e2 100644 --- a/tox.ini +++ b/tox.ini @@ -182,7 +182,7 @@ commands = basepython: python3.8 recreate = True deps = - -c dev-requirements.txt + -r dev-requirements.txt pylint flake8 isort @@ -196,10 +196,8 @@ commands = [testenv:docs] deps = - -c dev-requirements.txt - sphinx - sphinx-rtd-theme - sphinx-autodoc-typehints + -r dev-requirements.txt + -r docs-requirements.txt opentracing~=2.2.0 Deprecated>=1.2.6 thrift>=0.10.0 From 7c24fd8947ef0f50d1159256e5e34cb7d3aa0db8 Mon Sep 17 00:00:00 2001 From: Chris Kleinknecht Date: Fri, 28 Feb 2020 14:12:13 -0800 Subject: [PATCH 3/7] Remove docs requirements versions --- docs-requirements.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs-requirements.txt b/docs-requirements.txt index 4b654a15c8..f852e84dfc 100644 --- a/docs-requirements.txt +++ b/docs-requirements.txt @@ -1,3 +1,3 @@ -sphinx~=2.1 -sphinx-rtd-theme~=0.4 -sphinx-autodoc-typehints~=1.10.2 +sphinx +sphinx-rtd-theme +sphinx-autodoc-typehints From 31a8f412c20802d84d7cd0b4cf1e40bda4c4822b Mon Sep 17 00:00:00 2001 From: Chris Kleinknecht Date: Fri, 28 Feb 2020 14:20:39 -0800 Subject: [PATCH 4/7] Use explicit deps with constraints in tox but don't actually restrict to specific versions of dev-only packages. --- tox.ini | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/tox.ini b/tox.ini index f26f0a57e2..888fd938e8 100644 --- a/tox.ini +++ b/tox.ini @@ -182,7 +182,7 @@ commands = basepython: python3.8 recreate = True deps = - -r dev-requirements.txt + -c dev-requirements.txt pylint flake8 isort @@ -196,8 +196,11 @@ commands = [testenv:docs] deps = - -r dev-requirements.txt - -r docs-requirements.txt + -c dev-requirements.txt + -c docs-requirements.txt + sphinx + sphinx-rtd-theme + sphinx-autodoc-typehints opentracing~=2.2.0 Deprecated>=1.2.6 thrift>=0.10.0 From 4af9826d7b961fc8b15c5d998530284ec358e572 Mon Sep 17 00:00:00 2001 From: Chris Kleinknecht Date: Fri, 28 Feb 2020 14:28:41 -0800 Subject: [PATCH 5/7] Stick to known good sphinx and etc. versions --- docs-requirements.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs-requirements.txt b/docs-requirements.txt index f852e84dfc..4b654a15c8 100644 --- a/docs-requirements.txt +++ b/docs-requirements.txt @@ -1,3 +1,3 @@ -sphinx -sphinx-rtd-theme -sphinx-autodoc-typehints +sphinx~=2.1 +sphinx-rtd-theme~=0.4 +sphinx-autodoc-typehints~=1.10.2 From 3e7a9e9eacb677424976b6d6f01959100fd26db8 Mon Sep 17 00:00:00 2001 From: Chris Kleinknecht Date: Fri, 28 Feb 2020 14:31:58 -0800 Subject: [PATCH 6/7] Bump sphinx version --- docs-requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-requirements.txt b/docs-requirements.txt index 4b654a15c8..66a0287248 100644 --- a/docs-requirements.txt +++ b/docs-requirements.txt @@ -1,3 +1,3 @@ -sphinx~=2.1 +sphinx~=2.4 sphinx-rtd-theme~=0.4 sphinx-autodoc-typehints~=1.10.2 From 77902af5dffe9ee2778672b1ae28f8b1eaac8bbc Mon Sep 17 00:00:00 2001 From: Chris Kleinknecht Date: Mon, 2 Mar 2020 11:09:08 -0800 Subject: [PATCH 7/7] Add ext docs requirements --- docs-requirements.txt | 7 +++++++ tox.ini | 11 ++++++----- 2 files changed, 13 insertions(+), 5 deletions(-) diff --git a/docs-requirements.txt b/docs-requirements.txt index 66a0287248..ab952473a9 100644 --- a/docs-requirements.txt +++ b/docs-requirements.txt @@ -1,3 +1,10 @@ sphinx~=2.4 sphinx-rtd-theme~=0.4 sphinx-autodoc-typehints~=1.10.2 + +# Required by ext packages +opentracing~=2.2.0 +Deprecated>=1.2.6 +thrift>=0.10.0 +pymongo~=3.1 +flask~=1.0 diff --git a/tox.ini b/tox.ini index 888fd938e8..3588ca6949 100644 --- a/tox.ini +++ b/tox.ini @@ -201,11 +201,12 @@ deps = sphinx sphinx-rtd-theme sphinx-autodoc-typehints - opentracing~=2.2.0 - Deprecated>=1.2.6 - thrift>=0.10.0 - pymongo ~= 3.1 - flask~=1.0 + # Required by ext packages + opentracing + Deprecated + thrift + pymongo + flask changedir = docs