From 958df7b5a982a8633135bcd8a42a5339cb5fc7b4 Mon Sep 17 00:00:00 2001 From: Vijay Venkatesh Kumar Date: Tue, 1 Nov 2022 12:02:45 -0400 Subject: Doc config updates Change-Id: If02f4d94a9a95a54db926d4c6262df08b7582664 Signed-off-by: Vijay Venkatesh Kumar Issue-ID: DCAEGEN2-3301 Signed-off-by: Vijay Venkatesh Kumar --- .readthedocs.yaml | 6 +++--- docs/_static/css/ribbon.css | 4 ++-- docs/conf.py | 29 ++++++++++++++++++++++++++--- docs/requirements-docs.txt | 6 +++++- docs/tox.ini | 26 ++++++++++++++++++-------- 5 files changed, 54 insertions(+), 17 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 3797dc8b..82889b5a 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -5,9 +5,6 @@ # Required version: 2 -formats: - - htmlzip - build: image: latest @@ -16,5 +13,8 @@ python: install: - requirements: docs/requirements-docs.txt +submodules: + include: all + sphinx: configuration: docs/conf.py diff --git a/docs/_static/css/ribbon.css b/docs/_static/css/ribbon.css index 6008cb1a..7342cdc0 100644 --- a/docs/_static/css/ribbon.css +++ b/docs/_static/css/ribbon.css @@ -59,5 +59,5 @@ /* fix width of the screen */ .wy-nav-content { - max-width: none; -} + max-width: 800px; +} \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index d211470a..320a881c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,15 +1,38 @@ -from docs_conf.conf import * - +project = "onap" +release = "master" +version = "master" branch = 'latest' master_doc = 'index' linkcheck_ignore = [ - 'http://localhost', + r'http://localhost:\d+/' +] + +extensions = [ + 'sphinx.ext.intersphinx', + 'sphinx.ext.graphviz', + 'sphinxcontrib.blockdiag', + 'sphinxcontrib.seqdiag', + 'sphinxcontrib.swaggerdoc', + 'sphinxcontrib.plantuml' ] +pygments_style = "sphinx" +html_theme = "sphinx_rtd_theme" +html_theme_options = { + "style_nav_header_background": "white", + "sticky_navigation": "False" } +html_logo = "_static/logo_onap_2017.png" +html_favicon = "_static/favicon.ico" +html_static_path = ["_static"] +html_show_sphinx = False + intersphinx_mapping = {} html_last_updated_fmt = '%d-%b-%y %H:%M' def setup(app): app.add_css_file("css/ribbon.css") + + + diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 3b3441a8..ba3e0ec0 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -1,3 +1,7 @@ -lfdocs-conf sphinx>=4.2.0 # BSD sphinx-rtd-theme>=1.0.0 # MIT +sphinxcontrib-blockdiag # BSD +sphinxcontrib-seqdiag # BSD +sphinxcontrib-swaggerdoc +sphinxcontrib-spelling +sphinxcontrib-plantuml \ No newline at end of file diff --git a/docs/tox.ini b/docs/tox.ini index 64af58be..61596776 100644 --- a/docs/tox.ini +++ b/docs/tox.ini @@ -1,6 +1,6 @@ [tox] minversion = 1.6 -envlist = docs, +envlist = docs,docs-linkcheck,docs-spellcheck skipsdist = true [testenv:docs] @@ -8,21 +8,31 @@ basepython = python3.8 deps = -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 -commands = + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master +commands = sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html echo "Generated docs available in {toxinidir}/_build/html" +#commands = sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html + whitelist_externals = echo 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 - -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt -commands = echo "Link Checking not enforced" -#commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck -whitelist_externals = echo + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master +commands = echo "Link Checking not enforced" +#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 + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master +#commands = echo "Spell Check not enforced" +commands = sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck \ No newline at end of file -- cgit 1.2.3-korg