From dd7413d2458ad83166690f11690d8fc1dfed8b60 Mon Sep 17 00:00:00 2001
From: Aric Gardner <agardner@linuxfoundation.org>
Date: Wed, 5 Feb 2020 13:15:34 -0500
Subject: Fix readthedocs.yml

Also fix conf.py lint errors
etc/requirements.txt is hardcoded in rtd config
to support older builds I cannot change it
untill the next release

Issue-ID: CIMAN-33
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
Change-Id: I27f1dcf32d226ea094b20ad275b318d07fa9648b
---
 .readthedocs.yaml          | 20 ++++++++++++--------
 docs/requirements-docs.txt | 15 ---------------
 etc/requirements.txt       | 15 +++++++++++++++
 tox.ini                    | 15 ++++++++++-----
 4 files changed, 37 insertions(+), 28 deletions(-)
 delete mode 100644 docs/requirements-docs.txt
 create mode 100644 etc/requirements.txt

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index f9b33a141..55bc765b1 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -1,17 +1,21 @@
-# Formats in addition to HTML
+---
+# .readthedocs.yml
+# # Read the Docs configuration file
+# # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+# # Required
+#
+version: 2
 
 formats:
    - htmlzip
 
-python:
-  version: 3.7
-  install:
-    - requirements: docs/requirements-docs.txt
-
-# Build Container
 build:
    image: latest
 
+python:
+   version: 3.7
+   install:
+      - requirements: etc/requirements.txt
 
 sphinx:
-    configuration: docs/conf.py
+   configuration: docs/conf.py
diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
deleted file mode 100644
index b3188ddd3..000000000
--- a/docs/requirements-docs.txt
+++ /dev/null
@@ -1,15 +0,0 @@
-tox
-Sphinx
-doc8
-docutils
-setuptools
-six
-sphinx_rtd_theme>=0.4.3
-sphinxcontrib-blockdiag
-sphinxcontrib-needs>=0.2.3
-sphinxcontrib-nwdiag
-sphinxcontrib-seqdiag
-sphinxcontrib-swaggerdoc
-sphinxcontrib-plantuml
-sphinx_bootstrap_theme
-lfdocs-conf
diff --git a/etc/requirements.txt b/etc/requirements.txt
new file mode 100644
index 000000000..b3188ddd3
--- /dev/null
+++ b/etc/requirements.txt
@@ -0,0 +1,15 @@
+tox
+Sphinx
+doc8
+docutils
+setuptools
+six
+sphinx_rtd_theme>=0.4.3
+sphinxcontrib-blockdiag
+sphinxcontrib-needs>=0.2.3
+sphinxcontrib-nwdiag
+sphinxcontrib-seqdiag
+sphinxcontrib-swaggerdoc
+sphinxcontrib-plantuml
+sphinx_bootstrap_theme
+lfdocs-conf
diff --git a/tox.ini b/tox.ini
index 907cc6375..d4352d303 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,11 +1,13 @@
 [tox]
 minversion = 1.6
-envlist = docs
+envlist = docs,
+#         docs-linkcheck,
+
 skipsdist = true
 
 [testenv:docs]
 basepython = python3
-deps = -r{toxinidir}/docs/requirements-docs.txt
+deps = -r{toxinidir}/etc/requirements.txt
 commands =
     sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
     echo "Generated docs available in {toxinidir}/docs/_build/html"
@@ -16,7 +18,7 @@ whitelist_externals =
 
 [testenv:local]
 basepython = python3
-deps = -r{toxinidir}/docs/requirements-docs.txt
+deps = -r{toxinidir}/etc/requirements.txt
 commands =
     git submodule update --depth 100 --init
     sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
@@ -25,10 +27,13 @@ whitelist_externals =
     echo
     git
 
-[testenv:linkcheck]
+[testenv:docs-linkcheck]
 basepython = python3
 deps = -r{toxinidir}/etc/requirements.txt
-commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
+commands = echo "Link Checking not enforced"
+#commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
+whitelist_externals =
+    echo
 
 [testenv:spellcheck]
 basepython = python3
-- 
cgit 1.2.3-korg