Bring doc building up to python3 25/88625/1
authorJamo Luhrsen <jluhrsen@gmail.com>
Wed, 26 Feb 2020 00:52:08 +0000 (16:52 -0800)
committerRobert Varga <nite@hq.sk>
Thu, 26 Mar 2020 16:13:04 +0000 (16:13 +0000)
looks like readthedocs builds have been failing for a while
because python2 can't find some version of sphinx that is
now required by lfdocs-conf. Maybe an older version of
sphinx would still work, but it's time to catch up to
python3 anyway.

integration/test just added this same .readthedocs.yml
file which finally got it's rtd build to work after
having unknowingly been failing for a month:

https://git.opendaylight.org/gerrit/c/integration/test/+/88064
https://readthedocs.org/projects/odl-integrationtest/builds/?page=1

and netconf has been in the same boat:
https://readthedocs.org/projects/odl-netconf/builds/?page=1

Signed-off-by: Jamo Luhrsen <jluhrsen@gmail.com>
Change-Id: I63c01d8d9805ee492ebeb4d1b65723ab8a2d59b9
(cherry picked from commit bca11c23ab24a7119a3972e4629f46e9e0565abd)

.readthedocs.yml [new file with mode: 0644]
tox.ini

diff --git a/.readthedocs.yml b/.readthedocs.yml
new file mode 100644 (file)
index 0000000..5ff506f
--- /dev/null
@@ -0,0 +1,14 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+sphinx:
+    configuration: docs/conf.py
+
+python:
+    version: 3.7
+    install:
+        - requirements: docs/requirements.txt
diff --git a/tox.ini b/tox.ini
index 8d4a48fd5695e7b5b275a60975d277387ab10e15..4f9c226fd158276651b4c84c74cb984c7fec61b3 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -6,11 +6,13 @@ envlist =
 skipsdist = true
 
 [testenv:docs]
+basepython = python3
 deps = -rdocs/requirements.txt
 commands =
     sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
 
 [testenv:docs-linkcheck]
+basepython = python3
 deps = -rdocs/requirements.txt
 commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck