From a06eceb7002d9a61211d8e2721e675135d5a5875 Mon Sep 17 00:00:00 2001 From: thmsdt Date: Wed, 27 Oct 2021 15:05:51 +0200 Subject: fix documentation Issue-ID: CPS-754 Signed-off-by: thmsdt Change-Id: Ic14bbb60ba1d629d0f12b2d5e268a014cd344792 --- .readthedocs.yaml | 38 ++++++++++++++++++++++++++++++++++++++ docs/requirements-docs.txt | 1 + docs/tox.ini | 44 ++++++++++++++++++++++++++++++++++++++++++++ requirements.txt | 1 - tox.ini | 44 -------------------------------------------- 5 files changed, 83 insertions(+), 45 deletions(-) create mode 100644 .readthedocs.yaml create mode 100644 docs/requirements-docs.txt create mode 100644 docs/tox.ini delete mode 100644 requirements.txt delete mode 100644 tox.ini 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/docs/requirements-docs.txt b/docs/requirements-docs.txt new file mode 100644 index 0000000..5a3d2f1 --- /dev/null +++ b/docs/requirements-docs.txt @@ -0,0 +1 @@ +lfdocs-conf \ No newline at end of file diff --git a/docs/tox.ini b/docs/tox.ini new file mode 100644 index 0000000..0f25a72 --- /dev/null +++ b/docs/tox.ini @@ -0,0 +1,44 @@ +# ============LICENSE_START======================================================= +# Copyright (C) 2021 Bell Canada +# ================================================================================ +# 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========================================================= + +[tox] +minversion = 1.6 +envlist = docs +skipsdist = true + +[testenv:docs] +basepython = python3 +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}/doctrees ./ {toxinidir}/_build/html + echo "Generated docs available in {toxinidir}/_build/html" +whitelist_externals = + echo + git + sh + +[testenv:docs-linkcheck] +basepython = python3 +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" +whitelist_externals = + echo diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index 5a3d2f1..0000000 --- a/requirements.txt +++ /dev/null @@ -1 +0,0 @@ -lfdocs-conf \ No newline at end of file diff --git a/tox.ini b/tox.ini deleted file mode 100644 index 92aa4b2..0000000 --- a/tox.ini +++ /dev/null @@ -1,44 +0,0 @@ -# ============LICENSE_START======================================================= -# Copyright (C) 2021 Bell Canada -# ================================================================================ -# 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========================================================= - -[tox] -minversion = 1.6 -envlist = docs -skipsdist = true - -[testenv:docs] -basepython = python3 -deps = -r{toxinidir}/requirements.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" -whitelist_externals = - echo - git - sh - -[testenv:docs-linkcheck] -basepython = python3 -deps = -r{toxinidir}/requirements.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" -whitelist_externals = - echo -- cgit 1.2.3-korg