From c6e243a151fedc27a81f3173f599ab5b00437072 Mon Sep 17 00:00:00 2001 From: thmsdt Date: Fri, 5 Jan 2024 14:03:05 +0100 Subject: fix docs config file and rst errors Issue-ID: DOC-821 Change-Id: I07920bfb98386a128cfca57475d2caf151f247e0 Signed-off-by: thmsdt --- .gitreview | 2 +- docs/conf.py | 6 ++--- docs/sections/homingspecification.rst | 8 +++---- docs/sections/offeredapis.rst | 4 ++-- docs/sections/release-notes.rst | 1 + docs/tox.ini | 44 ++++++++++++++++------------------- 6 files changed, 31 insertions(+), 34 deletions(-) diff --git a/.gitreview b/.gitreview index 5a128d4..e8dff34 100644 --- a/.gitreview +++ b/.gitreview @@ -2,4 +2,4 @@ host=gerrit.onap.org port=29418 project=optf/has.git -defaultbranch=master \ No newline at end of file +defaultbranch=montreal \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 70937d7..372eadc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,6 @@ project = "onap" -release = "master" -version = "master" +release = "montreal" +version = "montreal" author = "Open Network Automation Platform" # yamllint disable-line rule:line-length @@ -30,7 +30,7 @@ extensions = [ # Change to {releasename} after you have created the new 'doc' branch. # -branch = 'latest' +branch = 'montreal' intersphinx_mapping = {} doc_url = 'https://docs.onap.org/projects' diff --git a/docs/sections/homingspecification.rst b/docs/sections/homingspecification.rst index ae09208..fcd5dec 100644 --- a/docs/sections/homingspecification.rst +++ b/docs/sections/homingspecification.rst @@ -159,8 +159,8 @@ Placemark An address expressed in geographic region-agnostic terms (referred to as a *placemark*). -*This is an example as of Frankfurt release. Support for this schema is - deferred to subsequent release.* +This is an example as of Frankfurt release. Support for this schema is deferred +to subsequent release. +-----------------------------------+----------------------------------+ | Key | Value | @@ -1837,7 +1837,7 @@ The constraint is applied between each pairwise combination of demands. For this reason, at least two demands must be specified, implicitly or explicitly. -.. code:: yaml +.. code:: constraints: network_requirements: @@ -1878,7 +1878,7 @@ malformed request. The constraint is applied between each demand and the referenced location, not across all pairwise combinations of Demands. -.. code:: yaml +.. code:: constraints: my_access_network_constraint: diff --git a/docs/sections/offeredapis.rst b/docs/sections/offeredapis.rst index f2fe4e2..12b3bec 100644 --- a/docs/sections/offeredapis.rst +++ b/docs/sections/offeredapis.rst @@ -35,7 +35,7 @@ State Diagram mode (the default), it will reset any plans found waiting and stuck in the ``solving`` state back to ``translated``. -.. code:: json +.. code:: { "name": "PLAN_NAME", @@ -43,7 +43,7 @@ the ``solving`` state back to ``translated``. "limit": 3 } -.. code:: json +.. code:: { "plan": { diff --git a/docs/sections/release-notes.rst b/docs/sections/release-notes.rst index bdb338b..1d99e13 100644 --- a/docs/sections/release-notes.rst +++ b/docs/sections/release-notes.rst @@ -645,6 +645,7 @@ OPTFRA code has been formally scanned during build time using NexusIQ and no Cri - `OPTFRA project page `_ - `Passing Badge information for OPTFRA `_ - `Project Vulnerability Review Table for OPTF `_ + **Upgrade Notes** To upgrade, run docker container or install from source, See Distribution page diff --git a/docs/tox.ini b/docs/tox.ini index 1613246..f69db1a 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,28 +8,24 @@ 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 + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=montreal 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.8 -#deps = -r{toxinidir}/requirements-docs.txt -commands = echo "Link Checking not enforced" -#commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck -whitelist_externals = echo - -[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 = - sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck + sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html +#[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?h=montreal +#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=montreal +#commands = +# sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck -- cgit 1.2.3-korg