From 59917cac1f5b2fd21a67101babca8f70240de7bf Mon Sep 17 00:00:00 2001 From: "Gode, Sebastian" Date: Tue, 30 May 2023 08:58:43 +0000 Subject: [PATCH] Added search index params on confpy Reviewed-by: tischrei Co-authored-by: Gode, Sebastian Co-committed-by: Gode, Sebastian --- otc_metadata/templates/conf.py.j2 | 9 +++++++++ tools/generate_doc_confpy.py | 17 +++++++++++++++++ 2 files changed, 26 insertions(+) diff --git a/otc_metadata/templates/conf.py.j2 b/otc_metadata/templates/conf.py.j2 index 3228eec8..b18b66a4 100644 --- a/otc_metadata/templates/conf.py.j2 +++ b/otc_metadata/templates/conf.py.j2 @@ -37,6 +37,15 @@ otcdocs_git_fqdn = '{{ git_fqdn }}' otcdocs_git_type = '{{ git_type }}' {%- endif %} +# Those variables are needed for indexing into OpenSearch +otcdocs_doc_environment = '{{ doc_environment }}' +otcdocs_doc_link = '{{ doc_link }}' +otcdocs_doc_title = '{{ doc_title }}' +otcdocs_doc_type = '{{ doc_type }}' +otcdocs_service_category = '{{ service_category }}' +otcdocs_service_title = '{{ service_title }}' +otcdocs_service_type = '{{ service_type }}' + # 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. diff --git a/tools/generate_doc_confpy.py b/tools/generate_doc_confpy.py index a9b0afc9..b761b7eb 100644 --- a/tools/generate_doc_confpy.py +++ b/tools/generate_doc_confpy.py @@ -150,6 +150,23 @@ def process_repositories(args, service): site_name="Internal Documentation Portal", logo_url="https://docs-int.otc-service.com", ) + context["doc_environment"] = args.target_environment + if doc['link']: + context["doc_link"] = doc['link'] + else: + context["doc_link"] = ( + '/' + + service['service_uri'] + + '/' + + doc['type'] + + '/' + ) + context["doc_title"] = doc['title'] + context["doc_type"] = doc['type'] + context["service_category"] = service['service_category'] + context["service_title"] = service['service_title'] + context["service_type"] = service['service_type'] + conf_py_content = conf_py_template.render(**context) with open(conf_py_path, "w", encoding="utf-8", newline="") as out: logging.debug(f"Generating {conf_py_path} from template...")