summaryrefslogtreecommitdiffstats
path: root/examples/sphinx/master
diff options
context:
space:
mode:
authorCédric Ollivier <cedric.ollivier@orange.com>2022-08-22 15:53:00 +0200
committerCédric Ollivier <cedric.ollivier@orange.com>2022-08-23 10:25:50 +0200
commitbcba18a222a8bcf8d937a60436574426306dadae (patch)
tree9b30310a78e8cdbe23608b66b6765639d843efe6 /examples/sphinx/master
parentc5123d6d7f9b5d7f5a0d3de143b778b291dbbb08 (diff)
Use official OpenStack Yoga upper constraints
As they remove sphinx from the list, we can switch to the official files. etc/upper-constraints.os.txt will be removed once all ONAP part of doc's conf.py are updated. It also fixes master's and releases's tox.ini and modifies conf.py to make spellcheck work. It syncs release/_static/css/ribbon.css which was obsolete. Issue-ID: DOC-782 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: I22757e2d6750e88ac7e83a0636fc0755976a2cbd
Diffstat (limited to 'examples/sphinx/master')
-rw-r--r--examples/sphinx/master/conf.py5
-rw-r--r--examples/sphinx/master/requirements-docs.txt2
-rw-r--r--examples/sphinx/master/spelling_wordlist.txt10
-rw-r--r--examples/sphinx/master/tox.ini76
4 files changed, 30 insertions, 63 deletions
diff --git a/examples/sphinx/master/conf.py b/examples/sphinx/master/conf.py
index a4823355e..d447769b9 100644
--- a/examples/sphinx/master/conf.py
+++ b/examples/sphinx/master/conf.py
@@ -31,6 +31,11 @@ intersphinx_mapping = {}
doc_url = 'https://docs.onap.org/projects'
master_doc = 'index'
+exclude_patterns = ['.tox']
+
+spelling_word_list_filename='spelling_wordlist.txt'
+spelling_lang = "en_GB"
+
#
# Example:
# intersphinx_mapping['onap-aai-aai-common'] = ('{}/onap-aai-aai-common/en/%s'.format(doc_url) % branch, None)
diff --git a/examples/sphinx/master/requirements-docs.txt b/examples/sphinx/master/requirements-docs.txt
index dc55d67b4..ed96b42b7 100644
--- a/examples/sphinx/master/requirements-docs.txt
+++ b/examples/sphinx/master/requirements-docs.txt
@@ -3,6 +3,4 @@ sphinx-rtd-theme>=1.0.0 # MIT
sphinxcontrib-blockdiag # BSD
sphinxcontrib-seqdiag # BSD
sphinxcontrib-swaggerdoc
-autopep8
sphinxcontrib-spelling
-pylint
diff --git a/examples/sphinx/master/spelling_wordlist.txt b/examples/sphinx/master/spelling_wordlist.txt
new file mode 100644
index 000000000..35c04686f
--- /dev/null
+++ b/examples/sphinx/master/spelling_wordlist.txt
@@ -0,0 +1,10 @@
+Goodger
+Mär
+docinfo
+overlined
+Docutils
+csv
+sectnum
+reST
+unicode
+defs
diff --git a/examples/sphinx/master/tox.ini b/examples/sphinx/master/tox.ini
index 6505b8512..3c27e3610 100644
--- a/examples/sphinx/master/tox.ini
+++ b/examples/sphinx/master/tox.ini
@@ -1,77 +1,31 @@
[tox]
minversion = 1.6
-envlist = docs,docs-linkcheck
+envlist = docs,docs-linkcheck,docs-spellcheck
skipsdist = true
[testenv:docs]
basepython = python3
deps =
- -r{toxinidir}/etc/requirements-docs.txt
- -c{toxinidir}/etc/upper-constraints.os.txt
- -c{toxinidir}/etc/upper-constraints.onap.txt
+ -r{toxinidir}/requirements-docs.txt
+ -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
commands =
- sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
- echo "Generated docs available in {toxinidir}/docs/_build/html"
-whitelist_externals =
- echo
- git
- sh
-
-[testenv:docs-templates]
-basepython = python3
-deps =
- -r{toxinidir}/etc/requirements-docs.txt
- -c{toxinidir}/etc/upper-constraints.os.txt
- -c{toxinidir}/etc/upper-constraints.onap.txt
-commands =
- sphinx-build -b html -n -d {envtmpdir}/doctrees -c {toxinidir}/docs ./docs/guides/onap-developer/how-to-use-docs/templates {toxinidir}/docs/_build/html/templates
- echo "Generated docs available in {toxinidir}/docs/_build/html/templates"
-whitelist_externals =
- echo
-
-[testenv:local]
-basepython = python3
-deps =
- -r{toxinidir}/etc/requirements-docs.txt
- -c{toxinidir}/etc/upper-constraints.os.txt
- -c{toxinidir}/etc/upper-constraints.onap.txt
-commands =
- git submodule update --depth 100 --init
- sphinx-build -q -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
- echo "Generated docs available in {toxinidir}/docs/_build/html"
-whitelist_externals =
- echo
- git
+ sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html
[testenv:docs-linkcheck]
basepython = python3
deps =
- -r{toxinidir}/etc/requirements-docs.txt
- -c{toxinidir}/etc/upper-constraints.os.txt
- -c{toxinidir}/etc/upper-constraints.onap.txt
-commands = sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck
-
-[testenv:spellcheck]
-basepython = python3
-deps =
- -r{toxinidir}/etc/requirements-docs.txt
- -c{toxinidir}/etc/upper-constraints.os.txt
- -c{toxinidir}/etc/upper-constraints.onap.txt
+ -r{toxinidir}/requirements-docs.txt
+ -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
commands =
- sphinx-build -b spelling -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/spellcheck
+ sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck
-[testenv:autopep8]
-deps =
- -r{toxinidir}/etc/requirements-docs.txt
- -c{toxinidir}/etc/upper-constraints.os.txt
- -c{toxinidir}/etc/upper-constraints.onap.txt
-commands =
- autopep8 --max-line-length 120 --in-place docs/conf.py
-
-[testenv:pylint]
+[testenv:docs-spellcheck]
+basepython = python3
deps =
- -r{toxinidir}/etc/requirements-docs.txt
- -c{toxinidir}/etc/upper-constraints.os.txt
- -c{toxinidir}/etc/upper-constraints.onap.txt
+ -r{toxinidir}/requirements-docs.txt
+ -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt
+ -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master
commands =
- pylint --max-line-length=120 --disable=missing-docstring --reports=y --score=y --output-format=colorized docs/conf.py
+ sphinx-build -W -b spelling -Dextensions=sphinxcontrib.spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck