diff options
author | Marek Szwałkiewicz <marek.szwalkiewicz@external.t-mobile.pl> | 2023-04-14 13:52:30 +0200 |
---|---|---|
committer | Marek Szwałkiewicz <marek.szwalkiewicz@external.t-mobile.pl> | 2023-04-17 13:52:05 +0200 |
commit | b1884e6e8c00e9aa48816a80a3c0da465f8c7bab (patch) | |
tree | 077596a83e5c7f140f21932de85237fb9dc8c635 | |
parent | 2af8eed99a00371db238c1021fbe110df59fd476 (diff) |
Fix documentation tests and structure
Remove deprecated whitelist_externals from tox.ini and
move docs/source to docs/. to satisfy the doc-rules
Issue-ID: INT-2221
Change-Id: I3162eccd91685b98972277b1f8f41b923321889a
Signed-off-by: Marek Szwałkiewicz <marek.szwalkiewicz@external.t-mobile.pl>
-rw-r--r-- | docs/Makefile | 2 | ||||
-rw-r--r-- | docs/_static/css/ribbon.css (renamed from docs/source/_static/css/ribbon.css) | 2 | ||||
-rw-r--r-- | docs/_static/data_flow.png (renamed from docs/source/_static/data_flow.png) | bin | 4969 -> 4969 bytes | |||
-rw-r--r-- | docs/_static/data_flow.puml (renamed from docs/source/_static/data_flow.puml) | 0 | ||||
-rwxr-xr-x | docs/_static/favicon.ico (renamed from docs/source/_static/favicon.ico) | bin | 2102 -> 2102 bytes | |||
-rw-r--r-- | docs/_static/logo_onap_2017.png (renamed from docs/source/_static/logo_onap_2017.png) | bin | 12278 -> 12278 bytes | |||
-rw-r--r-- | docs/conf.py (renamed from docs/source/conf.py) | 2 | ||||
-rw-r--r-- | docs/description.rst (renamed from docs/source/description.rst) | 0 | ||||
-rw-r--r-- | docs/index.rst (renamed from docs/source/index.rst) | 0 | ||||
-rw-r--r-- | docs/make.bat | 2 | ||||
-rw-r--r-- | docs/schemas.rst (renamed from docs/source/schemas.rst) | 0 | ||||
-rw-r--r-- | docs/schemas/resources/shared/aai_service_design_and_creation_service.rst (renamed from docs/source/schemas/resources/shared/aai_service_design_and_creation_service.rst) | 0 | ||||
-rw-r--r-- | docs/schemas/resources/shared/cloud_region_availability_zones.rst (renamed from docs/source/schemas/resources/shared/cloud_region_availability_zones.rst) | 0 | ||||
-rw-r--r-- | docs/schemas/resources/shared/cloud_region_esr_system_infos.rst (renamed from docs/source/schemas/resources/shared/cloud_region_esr_system_infos.rst) | 0 | ||||
-rw-r--r-- | docs/schemas/resources/shared/cloud_region_tenants.rst (renamed from docs/source/schemas/resources/shared/cloud_region_tenants.rst) | 0 | ||||
-rw-r--r-- | docs/schemas/resources/shared/complex.rst (renamed from docs/source/schemas/resources/shared/complex.rst) | 0 | ||||
-rw-r--r-- | docs/schemas/resources/shared/customer_service_subscription_tenant_relationship.rst (renamed from docs/source/schemas/resources/shared/customer_service_subscription_tenant_relationship.rst) | 0 | ||||
-rw-r--r-- | docs/schemas/resources/shared/line_of_business.rst (renamed from docs/source/schemas/resources/shared/line_of_business.rst) | 0 | ||||
-rw-r--r-- | docs/schemas/resources/shared/msb_profile.rst (renamed from docs/source/schemas/resources/shared/msb_profile.rst) | 0 | ||||
-rw-r--r-- | docs/schemas/resources/shared/owning_entity.rst (renamed from docs/source/schemas/resources/shared/owning_entity.rst) | 0 | ||||
-rw-r--r-- | docs/schemas/resources/shared/platform.rst (renamed from docs/source/schemas/resources/shared/platform.rst) | 0 | ||||
-rw-r--r-- | docs/schemas/resources/shared/project.rst (renamed from docs/source/schemas/resources/shared/project.rst) | 0 | ||||
-rw-r--r-- | docs/schemas/resources/shared/service_properties.rst (renamed from docs/source/schemas/resources/shared/service_properties.rst) | 0 | ||||
-rw-r--r-- | docs/schemas/resources/shared/service_resources.rst (renamed from docs/source/schemas/resources/shared/service_resources.rst) | 0 | ||||
-rw-r--r-- | docs/schemas/resources/shared/vendor.rst (renamed from docs/source/schemas/resources/shared/vendor.rst) | 0 | ||||
-rw-r--r-- | docs/schemas/resources/shared/vsp.rst (renamed from docs/source/schemas/resources/shared/vsp.rst) | 0 | ||||
-rw-r--r-- | docs/schemas/resources/shared/xnf_deployment_artifact.rst (renamed from docs/source/schemas/resources/shared/xnf_deployment_artifact.rst) | 0 | ||||
-rw-r--r-- | docs/schemas/resources/shared/xnf_property.rst (renamed from docs/source/schemas/resources/shared/xnf_property.rst) | 0 | ||||
-rw-r--r-- | docs/schemas/resources/shared/xnf_resources.rst (renamed from docs/source/schemas/resources/shared/xnf_resources.rst) | 0 | ||||
-rw-r--r-- | docs/schemas/version_1_0.rst (renamed from docs/source/schemas/version_1_0.rst) | 0 | ||||
-rw-r--r-- | docs/schemas/version_1_1.rst (renamed from docs/source/schemas/version_1_1.rst) | 0 | ||||
-rw-r--r-- | docs/source/conf.yaml | 7 | ||||
-rw-r--r-- | docs/tags.rst (renamed from docs/source/tags.rst) | 0 | ||||
-rw-r--r-- | docs/tox.ini | 6 | ||||
-rw-r--r-- | docs/usage.rst (renamed from docs/source/usage.rst) | 0 | ||||
-rw-r--r-- | tox.ini | 19 |
36 files changed, 17 insertions, 23 deletions
diff --git a/docs/Makefile b/docs/Makefile index d0c3cbf..ed88099 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -5,7 +5,7 @@ # from the environment for the first two. SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build -SOURCEDIR = source +SOURCEDIR = . BUILDDIR = build # Put it first so that "make" without argument is like "make help". diff --git a/docs/source/_static/css/ribbon.css b/docs/_static/css/ribbon.css index 6008cb1..5d41632 100644 --- a/docs/source/_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; } diff --git a/docs/source/_static/data_flow.png b/docs/_static/data_flow.png Binary files differindex ffb41d8..ffb41d8 100644 --- a/docs/source/_static/data_flow.png +++ b/docs/_static/data_flow.png diff --git a/docs/source/_static/data_flow.puml b/docs/_static/data_flow.puml index 30f526d..30f526d 100644 --- a/docs/source/_static/data_flow.puml +++ b/docs/_static/data_flow.puml diff --git a/docs/source/_static/favicon.ico b/docs/_static/favicon.ico Binary files differindex cb712eb..cb712eb 100755 --- a/docs/source/_static/favicon.ico +++ b/docs/_static/favicon.ico diff --git a/docs/source/_static/logo_onap_2017.png b/docs/_static/logo_onap_2017.png Binary files differindex 5d064f4..5d064f4 100644 --- a/docs/source/_static/logo_onap_2017.png +++ b/docs/_static/logo_onap_2017.png diff --git a/docs/source/conf.py b/docs/conf.py index e782429..d065e20 100644 --- a/docs/source/conf.py +++ b/docs/conf.py @@ -1,5 +1,3 @@ -from docs_conf.conf import * - branch = 'latest' master_doc = 'index' diff --git a/docs/source/description.rst b/docs/description.rst index 3fa8d1a..3fa8d1a 100644 --- a/docs/source/description.rst +++ b/docs/description.rst diff --git a/docs/source/index.rst b/docs/index.rst index 9360ed3..9360ed3 100644 --- a/docs/source/index.rst +++ b/docs/index.rst diff --git a/docs/make.bat b/docs/make.bat index 061f32f..307157b 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -7,7 +7,7 @@ REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) -set SOURCEDIR=source +set SOURCEDIR=. set BUILDDIR=build if "%1" == "" goto help diff --git a/docs/source/schemas.rst b/docs/schemas.rst index c399ae1..c399ae1 100644 --- a/docs/source/schemas.rst +++ b/docs/schemas.rst diff --git a/docs/source/schemas/resources/shared/aai_service_design_and_creation_service.rst b/docs/schemas/resources/shared/aai_service_design_and_creation_service.rst index 300a549..300a549 100644 --- a/docs/source/schemas/resources/shared/aai_service_design_and_creation_service.rst +++ b/docs/schemas/resources/shared/aai_service_design_and_creation_service.rst diff --git a/docs/source/schemas/resources/shared/cloud_region_availability_zones.rst b/docs/schemas/resources/shared/cloud_region_availability_zones.rst index 7297a4b..7297a4b 100644 --- a/docs/source/schemas/resources/shared/cloud_region_availability_zones.rst +++ b/docs/schemas/resources/shared/cloud_region_availability_zones.rst diff --git a/docs/source/schemas/resources/shared/cloud_region_esr_system_infos.rst b/docs/schemas/resources/shared/cloud_region_esr_system_infos.rst index c57f12f..c57f12f 100644 --- a/docs/source/schemas/resources/shared/cloud_region_esr_system_infos.rst +++ b/docs/schemas/resources/shared/cloud_region_esr_system_infos.rst diff --git a/docs/source/schemas/resources/shared/cloud_region_tenants.rst b/docs/schemas/resources/shared/cloud_region_tenants.rst index 59608fa..59608fa 100644 --- a/docs/source/schemas/resources/shared/cloud_region_tenants.rst +++ b/docs/schemas/resources/shared/cloud_region_tenants.rst diff --git a/docs/source/schemas/resources/shared/complex.rst b/docs/schemas/resources/shared/complex.rst index ac00420..ac00420 100644 --- a/docs/source/schemas/resources/shared/complex.rst +++ b/docs/schemas/resources/shared/complex.rst diff --git a/docs/source/schemas/resources/shared/customer_service_subscription_tenant_relationship.rst b/docs/schemas/resources/shared/customer_service_subscription_tenant_relationship.rst index 824beb9..824beb9 100644 --- a/docs/source/schemas/resources/shared/customer_service_subscription_tenant_relationship.rst +++ b/docs/schemas/resources/shared/customer_service_subscription_tenant_relationship.rst diff --git a/docs/source/schemas/resources/shared/line_of_business.rst b/docs/schemas/resources/shared/line_of_business.rst index cd2c987..cd2c987 100644 --- a/docs/source/schemas/resources/shared/line_of_business.rst +++ b/docs/schemas/resources/shared/line_of_business.rst diff --git a/docs/source/schemas/resources/shared/msb_profile.rst b/docs/schemas/resources/shared/msb_profile.rst index e2ccc17..e2ccc17 100644 --- a/docs/source/schemas/resources/shared/msb_profile.rst +++ b/docs/schemas/resources/shared/msb_profile.rst diff --git a/docs/source/schemas/resources/shared/owning_entity.rst b/docs/schemas/resources/shared/owning_entity.rst index 6dc5047..6dc5047 100644 --- a/docs/source/schemas/resources/shared/owning_entity.rst +++ b/docs/schemas/resources/shared/owning_entity.rst diff --git a/docs/source/schemas/resources/shared/platform.rst b/docs/schemas/resources/shared/platform.rst index da713df..da713df 100644 --- a/docs/source/schemas/resources/shared/platform.rst +++ b/docs/schemas/resources/shared/platform.rst diff --git a/docs/source/schemas/resources/shared/project.rst b/docs/schemas/resources/shared/project.rst index 3c47e91..3c47e91 100644 --- a/docs/source/schemas/resources/shared/project.rst +++ b/docs/schemas/resources/shared/project.rst diff --git a/docs/source/schemas/resources/shared/service_properties.rst b/docs/schemas/resources/shared/service_properties.rst index 74af460..74af460 100644 --- a/docs/source/schemas/resources/shared/service_properties.rst +++ b/docs/schemas/resources/shared/service_properties.rst diff --git a/docs/source/schemas/resources/shared/service_resources.rst b/docs/schemas/resources/shared/service_resources.rst index ba5dd32..ba5dd32 100644 --- a/docs/source/schemas/resources/shared/service_resources.rst +++ b/docs/schemas/resources/shared/service_resources.rst diff --git a/docs/source/schemas/resources/shared/vendor.rst b/docs/schemas/resources/shared/vendor.rst index 8c2aede..8c2aede 100644 --- a/docs/source/schemas/resources/shared/vendor.rst +++ b/docs/schemas/resources/shared/vendor.rst diff --git a/docs/source/schemas/resources/shared/vsp.rst b/docs/schemas/resources/shared/vsp.rst index 55a8479..55a8479 100644 --- a/docs/source/schemas/resources/shared/vsp.rst +++ b/docs/schemas/resources/shared/vsp.rst diff --git a/docs/source/schemas/resources/shared/xnf_deployment_artifact.rst b/docs/schemas/resources/shared/xnf_deployment_artifact.rst index aa68d0a..aa68d0a 100644 --- a/docs/source/schemas/resources/shared/xnf_deployment_artifact.rst +++ b/docs/schemas/resources/shared/xnf_deployment_artifact.rst diff --git a/docs/source/schemas/resources/shared/xnf_property.rst b/docs/schemas/resources/shared/xnf_property.rst index f8066ed..f8066ed 100644 --- a/docs/source/schemas/resources/shared/xnf_property.rst +++ b/docs/schemas/resources/shared/xnf_property.rst diff --git a/docs/source/schemas/resources/shared/xnf_resources.rst b/docs/schemas/resources/shared/xnf_resources.rst index 71ad609..71ad609 100644 --- a/docs/source/schemas/resources/shared/xnf_resources.rst +++ b/docs/schemas/resources/shared/xnf_resources.rst diff --git a/docs/source/schemas/version_1_0.rst b/docs/schemas/version_1_0.rst index a7f700a..a7f700a 100644 --- a/docs/source/schemas/version_1_0.rst +++ b/docs/schemas/version_1_0.rst diff --git a/docs/source/schemas/version_1_1.rst b/docs/schemas/version_1_1.rst index ce74c91..ce74c91 100644 --- a/docs/source/schemas/version_1_1.rst +++ b/docs/schemas/version_1_1.rst diff --git a/docs/source/conf.yaml b/docs/source/conf.yaml deleted file mode 100644 index ab59281..0000000 --- a/docs/source/conf.yaml +++ /dev/null @@ -1,7 +0,0 @@ ---- -project_cfg: onap -project: onap - -# Change this to ReleaseBranchName to modify the header -default-version: latest -# diff --git a/docs/source/tags.rst b/docs/tags.rst index b16e83e..b16e83e 100644 --- a/docs/source/tags.rst +++ b/docs/tags.rst diff --git a/docs/tox.ini b/docs/tox.ini index c86077b..c18c28d 100644 --- a/docs/tox.ini +++ b/docs/tox.ini @@ -10,9 +10,9 @@ deps = -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt?h=master -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master commands = - sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./source {toxinidir}/_build/html + sphinx-build -W -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html echo "Generated docs available in {toxinidir}/_build/html" -whitelist_externals = +allowlist_externals = echo [testenv:docs-linkcheck] @@ -22,5 +22,5 @@ deps = -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt?h=master -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=master commands = - sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./source {toxinidir}/_build/linkcheck + sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck diff --git a/docs/source/usage.rst b/docs/usage.rst index 1d54d51..1d54d51 100644 --- a/docs/source/usage.rst +++ b/docs/usage.rst @@ -6,16 +6,19 @@ requires = pip >= 8 [testenv] basepython = python3.8 -whitelist_externals = +allowlist_externals = git bash + /bin/bash + sh + /bin/sh deps = coala-bears nodeenv [testenv:json] commands_pre = - /bin/sh -c "git --no-pager diff HEAD HEAD^ --name-only '*.json' > /tmp/.coalist_json" + /bin/sh -c "git --no-pager diff HEAD^ HEAD --name-only '*.json' > /tmp/.coalist_json" commands = # '\ ' at the end of command is needed for a case where above command returns empty list (it adds empty file # parameter to '--files' opt @@ -23,7 +26,7 @@ commands = [testenv:yaml] commands_pre = - /bin/sh -c "git --no-pager diff HEAD HEAD^ --name-only '*.yaml' '*.yml' > /tmp/.coalist_yaml" + /bin/sh -c "git --no-pager diff HEAD^ HEAD --name-only '*.yaml' '*.yml' > /tmp/.coalist_yaml" commands = # '\ ' at the end of command is needed for a case where above command returns empty list (it adds empty file # parameter to '--files' opt @@ -31,26 +34,26 @@ commands = [testenv:py] commands_pre = - /bin/sh -c "git --no-pager diff HEAD HEAD^ --name-only '*.py' > /tmp/.coalist_py" + /bin/sh -c "git --no-pager diff HEAD^ HEAD --name-only '*.py' > /tmp/.coalist_py" commands = /bin/bash -c "coala --non-interactive --disable-caching --no-autoapply-warn py --files $(</tmp/.coalist_py) \ " [testenv:rst] commands_pre = - /bin/sh -c "git --no-pager diff HEAD HEAD^ --name-only '*.rst' > /tmp/.coalist_rst" + /bin/sh -c "git --no-pager diff HEAD^ HEAD --name-only '*.rst' > /tmp/.coalist_rst" deps = -r{toxinidir}/docs/requirements-docs.txt -chttps://git.onap.org/doc/plain/etc/upper-constraints.os.txt -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt commands = - /bin/sh -c "sphinx-build -n -b html docs/source docs/build/html $(</tmp/.coalist_rst)" - /bin/sh -c "sphinx-build -n -b linkcheck docs/source docs/build/linkcheck $(</tmp/.coalist_rst)" + /bin/sh -c "sphinx-build -n -b html docs docs/build/html $(</tmp/.coalist_rst)" + /bin/sh -c "sphinx-build -n -b linkcheck docs docs/build/linkcheck $(</tmp/.coalist_rst)" [testenv:md] commands_pre = nodeenv -p --verbose npm install --global remark-cli - /bin/sh -c "git --no-pager diff HEAD HEAD^ --name-only '*.md' > /tmp/.coalist_md" + /bin/sh -c "git --no-pager diff HEAD^ HEAD --name-only '*.md' > /tmp/.coalist_md" commands = /bin/bash -c "coala --non-interactive --disable-caching --no-autoapply-warn md --files $(</tmp/.coalist_md) \ " |