From 66e5d4252c905e43725087ef3cb8c18a75a46d39 Mon Sep 17 00:00:00 2001 From: "Hasko, Vladimir" Date: Thu, 10 Aug 2023 14:43:28 +0000 Subject: [PATCH] fix sphinx problems with constraints Reviewed-by: vladimirhasko Co-authored-by: Hasko, Vladimir Co-committed-by: Hasko, Vladimir --- api-ref/source/conf.py | 18 +++++++---- tox.ini | 72 ++++++++++++++++++++++-------------------- umn/source/conf.py | 11 +++++++ 3 files changed, 60 insertions(+), 41 deletions(-) diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index c0bd4b2..3967284 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -30,6 +30,17 @@ otcdocs_repo_name = 'docs/document-database-service' 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 = '/document-database-service/api-ref/' +otcdocs_doc_title = 'API Reference' +otcdocs_doc_type = 'api-ref' +otcdocs_service_category = 'database' +otcdocs_service_title = 'Document Database Service' +otcdocs_service_type = 'dds' +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. @@ -98,9 +109,4 @@ html_static_path = ['_static'] html_copy_source = False # -- Options for PDF output -------------------------------------------------- -latex_documents = [ - ('index', - 'None.tex', - u'Document Database Service - API Reference', - u'OpenTelekomCloud', 'manual'), -] +latex_documents = [] diff --git a/tox.ini b/tox.ini index 0f238d1..60da261 100644 --- a/tox.ini +++ b/tox.ini @@ -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 @@ -34,13 +36,13 @@ allowlist_externals = commands = rm -rf doc/build/html doc/build/doctrees sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html - {[testenv:api-ref]commands} - {[testenv:json-api-ref]commands} {[testenv:umn]commands} {[testenv:json-umn]commands} + {[testenv:api-ref]commands} + {[testenv:json-api-ref]commands} [testenv:docs-pdf] -deps = -r{toxinidir}/doc/requirements.txt +deps = {[testenv:docs]deps} allowlist_externals = rm mkdir @@ -52,37 +54,9 @@ commands = {[testenv:umn-pdf-docs]commands} -# HTML version -[testenv:api-ref] -deps = -r{toxinidir}/doc/requirements.txt -allowlist_externals = - cp - mkdir -commands = - sphinx-build -W --keep-going -b html api-ref/source doc/build/html/api-ref - mkdir -p api-ref/build/html - cp -av doc/build/html/api-ref api-ref/build/html - -# Json version (for search) -[testenv:json-api-ref] -deps = -r{toxinidir}/doc/requirements.txt -allowlist_externals = - cp - mkdir - sh -commands = - sphinx-build -W --keep-going -b json api-ref/source doc/build/json/api-ref - # Drop data useless for the search - wrap it also with sh/xargs due to bugs - # in tox - sh -c "find doc/build/json -type d -and '(' -name '_images' -or -name '_static' -or -name '_sources' ')' -print0 | xargs -0 rm -rf" - mkdir -p api-ref/build/json - cp -av doc/build/json/api-ref api-ref/build/json - - - # HTML version [testenv:umn] -deps = -r{toxinidir}/doc/requirements.txt +deps = {[testenv:docs]deps} allowlist_externals = cp mkdir @@ -93,7 +67,7 @@ commands = # Json version (for search) [testenv:json-umn] -deps = -r{toxinidir}/doc/requirements.txt +deps = {[testenv:docs]deps} allowlist_externals = cp mkdir @@ -108,7 +82,7 @@ commands = # PDF version [testenv:umn-pdf-docs] -deps = -r{toxinidir}/doc/requirements.txt +deps = {[testenv:docs]deps} allowlist_externals = rm mkdir @@ -125,6 +99,34 @@ commands = cp umn/build/pdf/dds-umn.pdf doc/build/pdf/ +# HTML version +[testenv:api-ref] +deps = {[testenv:docs]deps} +allowlist_externals = + cp + mkdir +commands = + sphinx-build -W --keep-going -b html api-ref/source doc/build/html/api-ref + mkdir -p api-ref/build/html + cp -av doc/build/html/api-ref api-ref/build/html + +# Json version (for search) +[testenv:json-api-ref] +deps = {[testenv:docs]deps} +allowlist_externals = + cp + mkdir + sh +commands = + sphinx-build -W --keep-going -b json api-ref/source doc/build/json/api-ref + # Drop data useless for the search - wrap it also with sh/xargs due to bugs + # in tox + sh -c "find doc/build/json -type d -and '(' -name '_images' -or -name '_static' -or -name '_sources' ')' -print0 | xargs -0 rm -rf" + mkdir -p api-ref/build/json + cp -av doc/build/json/api-ref api-ref/build/json + + + [doc8] ignore = D001 diff --git a/umn/source/conf.py b/umn/source/conf.py index 542fcbf..e4fc08f 100644 --- a/umn/source/conf.py +++ b/umn/source/conf.py @@ -30,6 +30,17 @@ otcdocs_repo_name = 'docs/document-database-service' 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 = '/document-database-service/umn/' +otcdocs_doc_title = 'User Guide' +otcdocs_doc_type = 'umn' +otcdocs_service_category = 'database' +otcdocs_service_title = 'Document Database Service' +otcdocs_service_type = 'dds' +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.