Fix dev-guide in confpy

enable pdf until CC
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com> Co-authored-by: tischrei <tino.schreiber@t-systems.com> Co-committed-by: tischrei <tino.schreiber@t-systems.com>
2024-12-10 10:07:03 +00:00 · 2024-12-10 08:10:52 +00:00 · 2024-12-09 13:01:31 +00:00 · 2024-12-09 10:51:06 +00:00 · 2024-12-09 10:13:35 +00:00
34 changed files with 54 additions and 35 deletions
--- a/otc_metadata/data/documents/antiddos-api-ref.yaml
+++ b/otc_metadata/data/documents/antiddos-api-ref.yaml
@ -2,7 +2,7 @@
 hc_location: api/antiddos
 html_location: docs/antiddos/api-ref
 link: /anti-ddos/api-ref/
-pdf_name: antiddos-api-ref
+pdf_enabled: true
 rst_location: api-ref/source
 service_type: antiddos
 title: API Reference
--- a/otc_metadata/data/documents/antiddos-umn.yaml
+++ b/otc_metadata/data/documents/antiddos-umn.yaml
@ -2,7 +2,7 @@
 hc_location: usermanual/antiddos
 html_location: docs/antiddos/umn
 link: /anti-ddos/umn/
-pdf_name: antiddos-umn
+pdf_enabled: true
 rst_location: umn/source
 service_type: antiddos
 title: User Guide
--- a/otc_metadata/data/documents/aom-api-ref.yaml
+++ b/otc_metadata/data/documents/aom-api-ref.yaml
@ -2,7 +2,7 @@
 hc_location: api/aom
 html_location: docs/aom/api-ref
 link: /application-operations-management/api-ref/
-pdf_name: aom-api-ref
+pdf_enabled: true
 rst_location: api-ref/source
 service_type: aom
 title: API Reference
--- a/otc_metadata/data/documents/aom-umn.yaml
+++ b/otc_metadata/data/documents/aom-umn.yaml
@ -2,7 +2,7 @@
 hc_location: usermanual/aom
 html_location: docs/aom/umn
 link: /application-operations-management/umn/
-pdf_name: aom-umn
+pdf_enabled: true
 rst_location: umn/source
 service_type: aom
 title: User Guide
--- a/otc_metadata/data/documents/aom2-api-ref.yaml
+++ b/otc_metadata/data/documents/aom2-api-ref.yaml
@ -3,7 +3,7 @@ environment: internal
 hc_location: api/aom2
 html_location: docs/aom2/api-ref
 link: /application-operations-management-2/api-ref/
-pdf_name: aom2-api-ref
+pdf_enabled: true
 rst_location: api-ref/source
 service_type: aom2
 title: API Reference
--- a/otc_metadata/data/documents/aom2-umn.yaml
+++ b/otc_metadata/data/documents/aom2-umn.yaml
@ -3,7 +3,7 @@ environment: internal
 hc_location: usermanual/aom2
 html_location: docs/aom2/umn
 link: /application-operations-management-2/umn/
-pdf_name: aom2-umn
+pdf_enabled: true
 rst_location: umn/source
 service_type: aom2
 title: User Guide
--- a/otc_metadata/data/documents/apig-api-ref.yaml
+++ b/otc_metadata/data/documents/apig-api-ref.yaml
@ -2,7 +2,7 @@
 hc_location: api/apig
 html_location: docs/apig/api-ref
 link: /api-gateway/api-ref/
-pdf_name: apig-api-ref
+pdf_enabled: true
 rst_location: api-ref/source
 service_type: apig
 title: API Reference
--- a/otc_metadata/data/documents/apig-dev.yaml
+++ b/otc_metadata/data/documents/apig-dev.yaml
@ -3,7 +3,7 @@ environment: hidden
 hc_location: devg/apig
 html_location: docs/apig/dev
 link: /api-gateway/dev-guide/
-pdf_name: apig-dev-guide
+pdf_enabled: true
 rst_location: dev_guide/source
 service_type: apig
 title: Developer Guide
--- a/otc_metadata/data/documents/apig-umn.yaml
+++ b/otc_metadata/data/documents/apig-umn.yaml
@ -2,7 +2,7 @@
 hc_location: usermanual/apig
 html_location: docs/apig/umn
 link: /api-gateway/umn/
-pdf_name: apig-umn
+pdf_enabled: true
 rst_location: umn/source
 service_type: apig
 title: User Guide
--- a/otc_metadata/data/documents/apiu-guidelines.yaml
+++ b/otc_metadata/data/documents/apiu-guidelines.yaml
@ -3,7 +3,7 @@ environment: internal
 hc_location: api-usage/guidelines
 html_location: docs/apiu/guidelines
 link: /api-usage/guidelines/
-pdf_name: apiu-guidelines
+pdf_enabled: true
 rst_location: doc/guidelines/source
 service_type: apiu
 title: API Usage Guidelines
--- a/otc_metadata/data/documents/apm-api-ref.yaml
+++ b/otc_metadata/data/documents/apm-api-ref.yaml
@ -3,7 +3,7 @@ environment: internal
 hc_location: api/apm
 html_location: docs/apm/api-ref
 link: /application-performance-management/api-ref/
-pdf_name: apm-api-ref
+pdf_enabled: true
 rst_location: api-ref/source
 service_type: apm
 title: API Reference
--- a/otc_metadata/data/documents/apm-umn.yaml
+++ b/otc_metadata/data/documents/apm-umn.yaml
@ -3,7 +3,7 @@ environment: public
 hc_location: usermanual/apm
 html_location: docs/apm/umn
 link: /application-performance-management/umn/
-pdf_name: apm-umn
+pdf_enabled: true
 rst_location: umn/source
 service_type: apm
 title: User Guide
--- a/otc_metadata/data/documents/as-api-ref.yaml
+++ b/otc_metadata/data/documents/as-api-ref.yaml
@ -2,7 +2,7 @@
 hc_location: api/as
 html_location: docs/as/api-ref
 link: /auto-scaling/api-ref/
-pdf_name: as-api-ref
+pdf_enabled: true
 rst_location: api-ref/source
 service_type: as
 title: API Reference
--- a/otc_metadata/data/documents/as-dev.yaml
+++ b/otc_metadata/data/documents/as-dev.yaml
@ -2,7 +2,7 @@
 hc_location: devg/as
 html_location: docs/as/dev
 link: /auto-scaling/dev-guide/
-pdf_name: as-dev-guide
+pdf_enabled: true
 rst_location: dev_guide/source
 service_type: as
 title: Developer Guide
--- a/otc_metadata/data/documents/as-umn.yaml
+++ b/otc_metadata/data/documents/as-umn.yaml
@ -2,7 +2,7 @@
 hc_location: usermanual/as
 html_location: docs/as/umn
 link: /auto-scaling/umn/
-pdf_name: as-umn
+pdf_enabled: true
 rst_location: umn/source
 service_type: as
 title: User Guide
--- a/otc_metadata/data/documents/asm-api-ref.yaml
+++ b/otc_metadata/data/documents/asm-api-ref.yaml
@ -3,7 +3,7 @@ environment: internal
 hc_location: api/asm
 html_location: docs/asm/api-ref
 link: /application-service-mesh/api-ref/
-pdf_name: asm-api-ref
+pdf_enabled: true
 rst_location: api-ref/source
 service_type: asm
 title: API Reference
--- a/otc_metadata/data/documents/asm-best-practice.yaml
+++ b/otc_metadata/data/documents/asm-best-practice.yaml
@ -3,7 +3,7 @@ hc_location: bestpractice/asm
 environment: internal
 html_location: docs/asm/best-practice
 link: /application-service-mesh/best-practice/
-pdf_name: asm-best-practice
+pdf_enabled: true
 rst_location: doc/best-practice/source
 service_type: asm
 title: Best Practice
--- a/otc_metadata/data/documents/asm-umn.yaml
+++ b/otc_metadata/data/documents/asm-umn.yaml
@ -3,7 +3,7 @@ environment: public
 hc_location: usermanual/asm
 html_location: docs/asm/umn
 link: /application-service-mesh/umn/
-pdf_name: asm-umn
+pdf_enabled: true
 rst_location: umn/source
 service_type: asm
 title: User Guide
--- a/otc_metadata/data/documents/bd-umn.yaml
+++ b/otc_metadata/data/documents/bd-umn.yaml
@ -1,6 +1,7 @@
 ---
 link: /business-dashboard/umn/
 rst_location: umn/source
+pdf_enabled: false
 service_type: bd
 title: User Guide
 type: umn
--- a/otc_metadata/data/documents/bms-api-ref.yaml
+++ b/otc_metadata/data/documents/bms-api-ref.yaml
@ -2,7 +2,7 @@
 hc_location: api/bms
 html_location: docs/bms/api-ref
 link: /bare-metal-server/api-ref/
-pdf_name: bms-api-ref
+pdf_enabled: true
 rst_location: api-ref/source
 service_type: bms
 title: API Reference
--- a/otc_metadata/data/documents/bms-dev.yaml
+++ b/otc_metadata/data/documents/bms-dev.yaml
@ -2,7 +2,7 @@
 hc_location: devg/bms
 html_location: docs/bms/dev
 link: /bare-metal-server/dev-guide/
-pdf_name: bms-dev-guide
+pdf_enabled: true
 rst_location: dev_guide/source
 service_type: bms
 title: Developer Guide
--- a/otc_metadata/data/documents/bms-image-creation-guide.yaml
+++ b/otc_metadata/data/documents/bms-image-creation-guide.yaml
@ -2,7 +2,7 @@
 hc_location: bpicg/bms
 html_location: docs/bms/image-creation-guide
 link: /bare-metal-server/image-creation-guide/
-pdf_name: bms-image-creation-guide
+pdf_enabled: true
 rst_location: doc/image-creation-guide/source
 service_type: bms
 title: Private Image Creation Guide
--- a/otc_metadata/data/documents/bms-umn.yaml
+++ b/otc_metadata/data/documents/bms-umn.yaml
@ -2,7 +2,7 @@
 hc_location: usermanual/bms
 html_location: docs/bms/umn
 link: /bare-metal-server/umn/
-pdf_name: bms-umn
+pdf_enabled: true
 rst_location: umn/source
 service_type: bms
 title: User Guide
--- a/otc_metadata/data/documents/cbr-api-ref.yaml
+++ b/otc_metadata/data/documents/cbr-api-ref.yaml
@ -2,7 +2,7 @@
 hc_location: api/cbr
 html_location: docs/cbr/api-ref
 link: /cloud-backup-recovery/api-ref/
-pdf_name: cbr-api-ref
+pdf_enabled: true
 rst_location: api-ref/source
 service_type: cbr
 title: API Reference
--- a/otc_metadata/data/documents/cbr-best-practice.yaml
+++ b/otc_metadata/data/documents/cbr-best-practice.yaml
@ -3,7 +3,7 @@ hc_location: bestpractice/cbr
 environment: internal
 html_location: docs/cbr/best-practice
 link: /cloud-backup-recovery/best-practice/
-pdf_name: cbr-best-practice
+pdf_enabled: true
 rst_location: doc/best-practice/source
 service_type: cbr
 title: Best Practice
--- a/otc_metadata/data/documents/cbr-umn.yaml
+++ b/otc_metadata/data/documents/cbr-umn.yaml
@ -2,7 +2,7 @@
 hc_location: usermanual/cbr
 html_location: docs/cbr/umn
 link: /cloud-backup-recovery/umn/
-pdf_name: cbr-umn
+pdf_enabled: true
 rst_location: umn/source
 service_type: cbr
 title: User Guide
--- a/otc_metadata/data/documents/cc-api-ref.yaml
+++ b/otc_metadata/data/documents/cc-api-ref.yaml
@ -1,6 +1,6 @@
 ---
 link: /cloud-create/api-ref/
-pdf_name: cc-api-ref
+pdf_enabled: true
 rst_location: api-ref/source
 service_type: cc
 title: API Reference
--- a/otc_metadata/data/documents/cc-umn.yaml
+++ b/otc_metadata/data/documents/cc-umn.yaml
@ -1,7 +1,7 @@
 ---
 html_location: docs/cc/umn
 link: /cloud-create/umn/
-pdf_name: cc-umn
+pdf_enabled: true
 rst_location: umn/source
 service_type: cc
 title: User Guide
--- a/otc_metadata/data/documents/geminidb-api-ref.yaml
+++ b/otc_metadata/data/documents/geminidb-api-ref.yaml
@ -2,7 +2,7 @@
 hc_location: api/nosql
 html_location: docs/geminidb/api-ref
 link: /geminidb/api-ref/
-pdf_name: geminidb-api-ref
+pdf_enabled: true
 rst_location: api-ref/source
 service_type: geminidb
 title: API Reference
--- a/otc_metadata/data/documents/geminidb-umn.yaml
+++ b/otc_metadata/data/documents/geminidb-umn.yaml
@ -2,7 +2,7 @@
 hc_location: usermanual/nosql
 html_location: docs/geminidb/umn
 link: /geminidb/umn/
-pdf_name: geminidb-umn
+pdf_enabled: true
 rst_location: umn/source
 service_type: geminidb
 title: User Guide
--- a/otc_metadata/templates/conf.py.j2
+++ b/otc_metadata/templates/conf.py.j2
@ -126,9 +126,13 @@ html_copy_source = False

 # -- Options for PDF output --------------------------------------------------
 latex_documents = [
-{%- if pdf_name is defined %}
+{%- if doc_type %}
    ('index',
-     '{{ pdf_name }}.tex',
+    {%- if doc_type == 'dev' %}
+     '{{ service_type }}-dev-guide.tex',
+    {%- else %}
+     '{{ service_type }}-{{ doc_type }}.tex',
+    {% endif -%}
     u'{{ title }}',
     u'OpenTelekomCloud', 'manual'),
 {% endif -%}
--- a/otc_metadata/templates/tox.ini.j2
+++ b/otc_metadata/templates/tox.ini.j2
@ -44,7 +44,7 @@ commands =
  {[testenv:json-{{ doc.type }}]commands}
 {%- endfor %}

-[testenv:docs-pdf]
+[testenv:pdf-docs]
 deps =
  {[testenv:docs]deps}
  {[testenv:bindeps]deps}
@ -63,7 +63,7 @@ commands =
  wget -O {toxinidir}/_templates/tabular.tex.jinja https://gitea.eco.tsi-dev.otc-service.com/infra/docs-templates/raw/branch/main/templates/tabular.tex.jinja
  wget -O {toxinidir}/_templates/tabulary.tex.jinja https://gitea.eco.tsi-dev.otc-service.com/infra/docs-templates/raw/branch/main/templates/tabulary.tex.jinja
 {%- for doc in docs %}
-{%- if doc.pdf_name %}
+{%- if doc.pdf_enabled %}
  {[testenv:{{ doc.type }}-pdf-docs]commands}
 {%- endif %}
 {%- endfor %}
@ -107,7 +107,7 @@ commands =
  cp -av doc/build/json/{{ doc.type }} {{ doc.type }}/build/json
 {%- endif %}

-{% if doc.pdf_name -%}
+{% if doc.pdf_enabled -%}
 # PDF version
 [testenv:{{ doc.type }}-pdf-docs]
 deps = {[testenv:docs]deps}
@ -125,7 +125,7 @@ commands =
  bash -c "for f in {{ loc }}/build/pdf/*.tex; do sed -iorig 's/\.gif//g' $f; done"
  make -C {{ loc }}/build/pdf
  mkdir -p doc/build/pdf
-  cp {{ loc }}/build/pdf/{{ doc.pdf_name }}.pdf doc/build/pdf/
+  cp {{ loc }}/build/pdf/{{ service_type }}-{{ doc.type }}.pdf doc/build/pdf/
 {% endif %}
 {% endfor %}

--- a/otc_metadata/templates/zuul.yaml.j2
+++ b/otc_metadata/templates/zuul.yaml.j2
@ -4,6 +4,13 @@
    default-branch: main
    templates:
      - helpcenter-base-jobs
+    vars:
+      sphinx_pdf_files:
+      {%- for doc in docs %}
+      {%- if doc.pdf_enabled %}
+        - {{ service_type }}-{{ doc.type }}.pdf
+      {%- endif %}
+      {%- endfor %}
    check:
      jobs:
        - noop
--- a/tools/generate_doc_confpy.py
+++ b/tools/generate_doc_confpy.py
@ -276,6 +276,7 @@ def process_repositories(args, service):
            context["docs"].append(doc)

        context["target_environment"] = args.target_environment
+        context["service_type"] = service['service_type']

        tox_ini_content = tox_ini_template.render(**context)
        tox_ini_path = pathlib.Path(copy_to, "tox.ini")
@ -299,6 +300,12 @@ def process_repositories(args, service):

    if args.update_zuul:
        """Update zuul.yaml"""
+        context = dict(docs=[])
+        for doc in service_docs:
+            if doc["type"] == "dev":
+                doc["type"] = "dev-guide"
+            context["docs"].append(doc)
+        context["service_type"] = service['service_type']

        zuul_yaml_content = zuul_yaml_template.render(**context)
        zuul_yaml_path = pathlib.Path(copy_to, "zuul.yaml")
Author	SHA1	Message	Date
Sebastian Gode	b4ea770254	Fix dev-guide in confpy All checks were successful gl/check check status: success (b4ea770254601ed06c0152d7f442280e55501f31) Details gl/gate gate status: success (b4ea770254601ed06c0152d7f442280e55501f31) Details	2024-12-10 10:07:03 +00:00
tischrei	979d35ae1e	enable pdf until CC Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com> Co-authored-by: tischrei <tino.schreiber@t-systems.com> Co-committed-by: tischrei <tino.schreiber@t-systems.com>	2024-12-10 08:10:52 +00:00
Sebastian Gode	919d54f8d3	Fix issue with latex_documents Reviewed-by: tischrei <tino.schreiber@t-systems.com> Co-authored-by: Sebastian Gode <sebastian.gode@telekom.de> Co-committed-by: Sebastian Gode <sebastian.gode@telekom.de>	2024-12-09 13:01:31 +00:00
Sebastian Gode	016b67221c	Zuul changes for PDF Reviewed-by: tischrei <tino.schreiber@t-systems.com> Co-authored-by: Sebastian Gode <sebastian.gode@telekom.de> Co-committed-by: Sebastian Gode <sebastian.gode@telekom.de>	2024-12-09 10:51:06 +00:00
tischrei	a7ee45b3d8	enable pdf for gemini db documents Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com> Co-authored-by: tischrei <tino.schreiber@t-systems.com> Co-committed-by: tischrei <tino.schreiber@t-systems.com>	2024-12-09 10:13:35 +00:00