diff options
| -rw-r--r-- | .readthedocs.yaml | 23 | ||||
| -rw-r--r-- | docs/conf.py | 4 | ||||
| -rw-r--r-- | docs/requirements-docs.txt | 1 | ||||
| -rw-r--r-- | docs/tox.ini | 9 |
4 files changed, 19 insertions, 18 deletions
diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 7f740b7..f56b3b7 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,21 +1,18 @@ --- # .readthedocs.yml -# # Read the Docs configuration file -# # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details -# # Required -# -version: 2 +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details +# Required +version: 2 build: - image: latest + os: ubuntu-20.04 + tools: + python: "3.8" python: - version: 3.7 - install: - - requirements: docs/requirements-docs.txt - -submodules: - include: all + install: + - requirements: docs/requirements-docs.txt sphinx: - configuration: docs/conf.py + configuration: docs/conf.py diff --git a/docs/conf.py b/docs/conf.py index a9c42b6..8cdff9b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -36,7 +36,9 @@ intersphinx_mapping = {} doc_url = 'https://docs.onap.org/projects' master_doc = 'index' -exclude_patterns = ['.tox'] +exclude_patterns = [ + '.tox' +] spelling_word_list_filename='spelling_wordlist.txt' spelling_lang = "en_GB" diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 71df2ab..097282b 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -5,3 +5,4 @@ sphinxcontrib-seqdiag # BSD sphinxcontrib-swaggerdoc sphinxcontrib-spelling sphinxcontrib-plantuml +six diff --git a/docs/tox.ini b/docs/tox.ini index b9d7eb4..38771a6 100644 --- a/docs/tox.ini +++ b/docs/tox.ini @@ -7,7 +7,7 @@ skipsdist = true basepython = python3.8 deps = -r{toxinidir}/requirements-docs.txt - -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt + -chttps://releases.openstack.org/constraints/upper/yoga -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master commands = sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html @@ -16,7 +16,7 @@ commands = basepython = python3.8 deps = -r{toxinidir}/requirements-docs.txt - -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt + -chttps://releases.openstack.org/constraints/upper/yoga -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master commands = sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck @@ -25,7 +25,8 @@ commands = basepython = python3.8 deps = -r{toxinidir}/requirements-docs.txt - -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt + -chttps://releases.openstack.org/constraints/upper/yoga -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master commands = - sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck + sphinx-build -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck +# sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck |