From: thmsdt <thomas.kulik@telekom.de>
Date: Wed, 27 Oct 2021 13:05:51 +0000 (+0200)
Subject: fix documentation
X-Git-Tag: 1.1.0~17
X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=a06eceb7002d9a61211d8e2721e675135d5a5875;p=cps%2Fcps-temporal.git

fix documentation

Issue-ID: CPS-754

Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: Ic14bbb60ba1d629d0f12b2d5e268a014cd344792
---

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 0000000..9c22c0b
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,38 @@
+#  ============LICENSE_START=======================================================
+#  Copyright (C) 2021 Nordix Foundation
+#  ================================================================================
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+#
+#  SPDX-License-Identifier: Apache-2.0
+#  ============LICENSE_END=========================================================
+
+---
+# .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
+
+build:
+  image: latest
+
+python:
+  version: 3.7
+  install:
+    - requirements: docs/requirements-docs.txt
+
+sphinx:
+  configuration: docs/conf.py
diff --git a/requirements.txt b/docs/requirements-docs.txt
similarity index 100%
rename from requirements.txt
rename to docs/requirements-docs.txt
diff --git a/tox.ini b/docs/tox.ini
similarity index 85%
rename from tox.ini
rename to docs/tox.ini
index 92aa4b2..0f25a72 100644
--- a/tox.ini
+++ b/docs/tox.ini
@@ -23,12 +23,12 @@ skipsdist = true
 
 [testenv:docs]
 basepython = python3
-deps = -r{toxinidir}/requirements.txt
+deps = -r{toxinidir}/requirements-docs.txt
        -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt
        -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
 commands =
-    sphinx-build -b html -n -d {envtmpdir}/docs/doctrees ./docs {toxinidir}/docs/_build/html
-    echo "Generated docs available in {toxinidir}/docs/_build/html"
+    sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html
+    echo "Generated docs available in {toxinidir}/_build/html"
 whitelist_externals =
     echo
     git
@@ -36,7 +36,7 @@ whitelist_externals =
 
 [testenv:docs-linkcheck]
 basepython = python3
-deps = -r{toxinidir}/requirements.txt
+deps = -r{toxinidir}/requirements-docs.txt
        -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt
        -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt
 commands = echo "Link Checking not enforced"