diff options
author | thmsdt <thomas.kulik@telekom.de> | 2023-04-03 13:33:06 +0200 |
---|---|---|
committer | thmsdt <thomas.kulik@telekom.de> | 2023-04-17 12:40:50 +0200 |
commit | 2f07ec8a22ccce11ebe01f7d9ed9f947631d97ff (patch) | |
tree | 7c0183193fd2cfe4a34f08f1c6c115427f2279b0 /docs | |
parent | b0c6c0b98a4fefcd0b2c88102a06a61c5d624cd0 (diff) |
move requirements file and correct path in tox.ini
Issue-ID: DOC-811
Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: I7c1b2bb3bd2357d2de5458d4791d8ee20affc682
Diffstat (limited to 'docs')
-rw-r--r-- | docs/conf.py | 13 | ||||
-rw-r--r-- | docs/release/component-release-notes.rst | 1 | ||||
-rw-r--r-- | docs/requirements-docs.txt | 10 | ||||
-rw-r--r-- | docs/tox.ini | 33 |
4 files changed, 52 insertions, 5 deletions
diff --git a/docs/conf.py b/docs/conf.py index 88e12576d..e7af3f626 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -6,11 +6,15 @@ author = "Open Network Automation Platform" # yamllint disable-line rule:line-length copyright = "ONAP. Licensed under Creative Commons Attribution 4.0 International License" +exclude_patterns = [ + '.tox' +] + pygments_style = "sphinx" html_theme = "sphinx_rtd_theme" html_theme_options = { - "style_nav_header_background": "white", - "sticky_navigation": "False" } + "style_nav_header_background": "white", + "sticky_navigation": "False" } html_logo = "_static/logo_onap_2017.png" html_favicon = "_static/favicon.ico" html_static_path = ["_static"] @@ -20,9 +24,10 @@ extensions = [ 'sphinx.ext.intersphinx', 'sphinx.ext.graphviz', 'sphinxcontrib.blockdiag', + 'sphinxcontrib.plantuml', 'sphinxcontrib.seqdiag', + 'sphinxcontrib.spelling' , 'sphinxcontrib.swaggerdoc', - 'sphinxcontrib.plantuml', 'sphinx_toolbox.collapse' ] @@ -82,5 +87,5 @@ def setup(app): app.add_css_file("css/ribbon.css") linkcheck_ignore = [ - r'http://localhost:\d+/' + r'http://localhost:\d+/' ] diff --git a/docs/release/component-release-notes.rst b/docs/release/component-release-notes.rst index d02cccb22..c73512a43 100644 --- a/docs/release/component-release-notes.rst +++ b/docs/release/component-release-notes.rst @@ -22,7 +22,6 @@ AAI - Active and Available Inventory CCSDK - Common Controller Software Development Kit -------------------------------------------------- -- :ref:`ccsdk/cds <onap-ccsdk-cds:release_notes>` - :ref:`ccsdk/distribution <onap-ccsdk-distribution:release_notes>` - :ref:`ccsdk/oran <onap-ccsdk-oran:release_notes>` diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt new file mode 100644 index 000000000..5616848a1 --- /dev/null +++ b/docs/requirements-docs.txt @@ -0,0 +1,10 @@ +sphinx>=4.2.0 # BSD +sphinx-rtd-theme>=1.0.0 # MIT +sphinxcontrib-blockdiag # BSD +sphinxcontrib-seqdiag # BSD +sphinxcontrib-swaggerdoc +sphinxcontrib-spelling +sphinxcontrib-plantuml +sphinx_toolbox +autopep8 +pylint diff --git a/docs/tox.ini b/docs/tox.ini new file mode 100644 index 000000000..a90bc6429 --- /dev/null +++ b/docs/tox.ini @@ -0,0 +1,33 @@ +[tox] +minversion = 1.6 +envlist = docs,docs-linkcheck,docs-spellcheck +skipsdist = true + +[testenv:docs] +basepython = python3.8 +deps = + -r{toxinidir}/requirements-docs.txt + -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt + -c{toxinidir}/../etc/upper-constraints.onap.txt +commands = + sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html +allowlist_externals = + git + sh + +[testenv:docs-linkcheck] +basepython = python3.8 +deps = + -r{toxinidir}/requirements-docs.txt + -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt + -c{toxinidir}/../etc/upper-constraints.onap.txt +commands = sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck + +[testenv:docs-spellcheck] +basepython = python3.8 +deps = + -r{toxinidir}/requirements-docs.txt + -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt + -c{toxinidir}/../etc/upper-constraints.onap.txt +commands = + sphinx-build -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck |