oeotvos/software-repository-container
1
0
Fork 0
forked from docs/software-repository-container
Code Pull Requests Activity

fix sphinx problems with constraints

Browse Source 
Reviewed-by: vladimirhasko <vladimirhasko@gmail.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
This commit is contained in:
Hasko, Vladimir 2023-08-10 16:00:24 +00:00 committed by zuul
parent e08992d445
commit 662c9bff22
3 changed files with 32 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
api-ref/source/conf.py
View File

@ -30,6 +30,17 @@ otcdocs_repo_name = 'docs/software-repository-container'
otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
otcdocs_git_type = 'gitea'
# Those variables are needed for indexing into OpenSearch
otcdocs_doc_environment = 'internal'
otcdocs_doc_link = '/software-repository-container/api-ref/'
otcdocs_doc_title = 'API Reference'
otcdocs_doc_type = 'api-ref'
otcdocs_service_category = 'container'
otcdocs_service_title = 'Software Repository for Containers'
otcdocs_service_type = 'swr'
otcdocs_search_environment = 'hc_de'
otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/"
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.

18
tox.ini
View File

@ -24,7 +24,9 @@ commands = {posargs}
# This env is invoked in the periodic pipeline and is therefore responsible to
# build all relevant docs at once.
[testenv:docs]
deps = -r{toxinidir}/doc/requirements.txt
deps =
-r{toxinidir}/doc/requirements.txt
-c https://raw.githubusercontent.com/opentelekomcloud-docs/docs-constraints/main/constraints.txt
allowlist_externals =
mkdir
cp
@ -40,7 +42,7 @@ commands =
{[testenv:json-umn]commands}
[testenv:docs-pdf]
deps = -r{toxinidir}/doc/requirements.txt
deps = {[testenv:docs]deps}
allowlist_externals =
rm
mkdir
@ -55,7 +57,7 @@ commands =
# HTML version
[testenv:api-ref]
deps = -r{toxinidir}/doc/requirements.txt
deps = {[testenv:docs]deps}
allowlist_externals =
cp
mkdir
@ -66,7 +68,7 @@ commands =
# Json version (for search)
[testenv:json-api-ref]
deps = -r{toxinidir}/doc/requirements.txt
deps = {[testenv:docs]deps}
allowlist_externals =
cp
mkdir
@ -81,7 +83,7 @@ commands =
# PDF version
[testenv:api-ref-pdf-docs]
deps = -r{toxinidir}/doc/requirements.txt
deps = {[testenv:docs]deps}
allowlist_externals =
rm
mkdir
@ -100,7 +102,7 @@ commands =
# HTML version
[testenv:umn]
deps = -r{toxinidir}/doc/requirements.txt
deps = {[testenv:docs]deps}
allowlist_externals =
cp
mkdir
@ -111,7 +113,7 @@ commands =
# Json version (for search)
[testenv:json-umn]
deps = -r{toxinidir}/doc/requirements.txt
deps = {[testenv:docs]deps}
allowlist_externals =
cp
mkdir
@ -126,7 +128,7 @@ commands =
# PDF version
[testenv:umn-pdf-docs]
deps = -r{toxinidir}/doc/requirements.txt
deps = {[testenv:docs]deps}
allowlist_externals =
rm
mkdir

11
umn/source/conf.py
View File

@ -30,6 +30,17 @@ otcdocs_repo_name = 'docs/software-repository-container'
otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
otcdocs_git_type = 'gitea'
# Those variables are needed for indexing into OpenSearch
otcdocs_doc_environment = 'internal'
otcdocs_doc_link = '/software-repository-container/umn/'
otcdocs_doc_title = 'User Guide'
otcdocs_doc_type = 'umn'
otcdocs_service_category = 'container'
otcdocs_service_title = 'Software Repository for Containers'
otcdocs_service_type = 'swr'
otcdocs_search_environment = 'hc_de'
otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/"
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.