From 7d4aacf61d9a8294a41b1ee7d115d572d6e9861d Mon Sep 17 00:00:00 2001 From: Sebastian Gode Date: Thu, 15 May 2025 11:11:16 +0000 Subject: [PATCH] Docs constraints new architecture Reviewed-by: Tino Schreiber Co-authored-by: Sebastian Gode Co-committed-by: Sebastian Gode --- otc_metadata/data/repositories/gloss.yaml | 4 ++-- otc_metadata/services.py | 13 ++++++------- otc_metadata/templates/tox.ini.j2 | 2 +- tools/generate_doc_confpy.py | 4 ++-- tools/generate_docexports_data.py | 2 +- 5 files changed, 12 insertions(+), 13 deletions(-) diff --git a/otc_metadata/data/repositories/gloss.yaml b/otc_metadata/data/repositories/gloss.yaml index ee3e0d4..4a91476 100644 --- a/otc_metadata/data/repositories/gloss.yaml +++ b/otc_metadata/data/repositories/gloss.yaml @@ -5,9 +5,9 @@ repositories: repo: opentelekomcloud-docs/glossary type: github cloud_environments: - - + - eu_de - environment: internal repo: docs/glossary type: gitea cloud_environments: - - + - eu_de diff --git a/otc_metadata/services.py b/otc_metadata/services.py index 2812ebc..6c6b07e 100644 --- a/otc_metadata/services.py +++ b/otc_metadata/services.py @@ -13,7 +13,6 @@ import copy import warnings -import json import otc_metadata.data @@ -76,7 +75,7 @@ class Services(object): def all_docs(self): "Service Docs data listing." return copy.deepcopy(self._service_data["documents"]) - + @property def all_repositories(self): "Service Repositories data listing." @@ -283,7 +282,7 @@ class Services(object): if not service: warnings.warn("No Service defition of type %s" % (cat)) continue - + for repositories in self.all_repositories: if repositories["service_type"] == service["service_type"]: res_doc = copy.deepcopy(doc) @@ -386,7 +385,7 @@ class Services(object): break break return res - + def get_service_with_repo_by_service_type(self, service_type): """Retrieve service with repos by service_type @@ -417,7 +416,7 @@ class Services(object): res[i]["repositories"] = repositories["repositories"] break return res - + def all_services_by_categories(self, cloud_environment, environments): """Retrieve all services sorted by categories """ @@ -440,7 +439,7 @@ class Services(object): for i, category in enumerate(res): if category["name"] == srv["service_category"]: res[i]["services"].append(srv) - + # Sort services for category in res: category["services"].sort(key=lambda x: x.get("service_title", "").lower()) @@ -448,4 +447,4 @@ class Services(object): # Sort categories res.sort(key=lambda x: x.get("name", "").lower()) - return res \ No newline at end of file + return res diff --git a/otc_metadata/templates/tox.ini.j2 b/otc_metadata/templates/tox.ini.j2 index edfd5f1..f855ee9 100644 --- a/otc_metadata/templates/tox.ini.j2 +++ b/otc_metadata/templates/tox.ini.j2 @@ -28,7 +28,7 @@ commands = {posargs} [testenv:docs] deps = -r{toxinidir}/doc/requirements.txt - -c https://raw.githubusercontent.com/opentelekomcloud-docs/docs-constraints/main/constraints.txt + -c https://raw.githubusercontent.com/opentelekomcloud-docs/docs-constraints/main/constraints/{{otcdocs_cloud_environment}}/{{target_environment}}/constraints.txt allowlist_externals = mkdir cp diff --git a/tools/generate_doc_confpy.py b/tools/generate_doc_confpy.py index f79b0d3..0904988 100644 --- a/tools/generate_doc_confpy.py +++ b/tools/generate_doc_confpy.py @@ -170,7 +170,7 @@ def process_repositories(args, service): if target_repo.get("type") != "github": context["git_type"] = target_repo["type"] if (args.target_environment == "public" - and args.cloud_environment == "swiss"): + and args.cloud_environment == "swiss"): context["html_options"] = dict( logo_url="https://docs.sc.otc.t-systems.com", ) @@ -183,7 +183,7 @@ def process_repositories(args, service): context["otcdocs_search_environment"] = "hc_de" context["otcdocs_search_index"] = "search_index_de" elif (args.target_environment == "internal" - and args.cloud_environment == "swiss"): + and args.cloud_environment == "swiss"): context["html_options"] = dict( disable_search=True, site_name="Internal Documentation Portal", diff --git a/tools/generate_docexports_data.py b/tools/generate_docexports_data.py index 265996b..5bc6273 100644 --- a/tools/generate_docexports_data.py +++ b/tools/generate_docexports_data.py @@ -24,7 +24,7 @@ def main(): data = otc_metadata.services.Services() data._sort_data() - docs = data.docs_html_by_category(environment="internal",cloud_environment=args.cloud_environment) + docs = data.docs_html_by_category(environment="internal", cloud_environment=args.cloud_environment) # Filter out documents with "disable_import": True for category, services in docs['categories'].items():