Compare commits
	
		
			4 Commits
		
	
	
		
			enable_pdf
			...
			enable_pdf
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| 05da5453c9 | |||
| 919d54f8d3 | |||
| 016b67221c | |||
| a7ee45b3d8 | 
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: api/drs
 | 
			
		||||
html_location: docs/drs/api-ref
 | 
			
		||||
link: /data-replication-service/api-ref/
 | 
			
		||||
pdf_name: drs-api-ref
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: api-ref/source
 | 
			
		||||
service_type: drs
 | 
			
		||||
title: API Reference
 | 
			
		||||
 | 
			
		||||
@ -3,7 +3,7 @@ hc_location: bestpractice/drs
 | 
			
		||||
environment: internal
 | 
			
		||||
html_location: docs/drs/best-practice
 | 
			
		||||
link: /data-replication-service/best-practice/
 | 
			
		||||
pdf_name: drs-best-practice
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: drs
 | 
			
		||||
title: Best Practice
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: usermanual/drs
 | 
			
		||||
html_location: docs/drs/umn
 | 
			
		||||
link: /data-replication-service/umn/
 | 
			
		||||
pdf_name: drs-umn
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: umn/source
 | 
			
		||||
service_type: drs
 | 
			
		||||
title: User Guide
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: api/dws
 | 
			
		||||
html_location: docs/dws/api-ref
 | 
			
		||||
link: /data-warehouse-service/api-ref/
 | 
			
		||||
pdf_name: dws-api-ref
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: api-ref/source
 | 
			
		||||
service_type: dws
 | 
			
		||||
title: API Reference
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: devg/dws
 | 
			
		||||
html_location: docs/dws/dev
 | 
			
		||||
link: /data-warehouse-service/dev-guide/
 | 
			
		||||
pdf_name: dws-dev-guide
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: dev_guide/source
 | 
			
		||||
service_type: dws
 | 
			
		||||
title: Developer Guide
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: tg/dws
 | 
			
		||||
html_location: docs/dws/tool
 | 
			
		||||
link: /data-warehouse-service/tool-guide/
 | 
			
		||||
pdf_name: dws-tool-guide
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: doc/tool/source
 | 
			
		||||
service_type: dws
 | 
			
		||||
title: Tool Guide
 | 
			
		||||
 | 
			
		||||
@ -2,6 +2,7 @@
 | 
			
		||||
hc_location: usermanual/dws
 | 
			
		||||
html_location: docs/dws/umn
 | 
			
		||||
link: /data-warehouse-service/umn/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: umn/source
 | 
			
		||||
service_type: dws
 | 
			
		||||
title: User Guide
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: api/ecs
 | 
			
		||||
html_location: docs/ecs/api-ref
 | 
			
		||||
link: /elastic-cloud-server/api-ref/
 | 
			
		||||
pdf_name: ecs-api-ref
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: api-ref/source
 | 
			
		||||
service_type: ecs
 | 
			
		||||
title: API Reference
 | 
			
		||||
 | 
			
		||||
@ -3,7 +3,7 @@ hc_location: bestpractice/ecs
 | 
			
		||||
environment: internal
 | 
			
		||||
html_location: docs/ecs/best-practice
 | 
			
		||||
link: /elastic-cloud-server/best-practice/
 | 
			
		||||
pdf_name: ecs-best-practice
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: ecs
 | 
			
		||||
title: Best Practice
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: devg/ecs
 | 
			
		||||
html_location: docs/ecs/dev
 | 
			
		||||
link: /elastic-cloud-server/dev-guide/
 | 
			
		||||
pdf_name: ecs-dev-guide
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: dev_guide/source
 | 
			
		||||
service_type: ecs
 | 
			
		||||
title: Developer Guide
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: usermanual/ecs
 | 
			
		||||
html_location: docs/ecs/umn
 | 
			
		||||
link: /elastic-cloud-server/umn/
 | 
			
		||||
pdf_name: ecs-umn
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: umn/source
 | 
			
		||||
service_type: ecs
 | 
			
		||||
title: User Guide
 | 
			
		||||
 | 
			
		||||
@ -1,5 +1,6 @@
 | 
			
		||||
---
 | 
			
		||||
link: /enterprise-dashboard/api-ref/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: api-ref/source
 | 
			
		||||
service_type: ed
 | 
			
		||||
title: API Reference
 | 
			
		||||
 | 
			
		||||
@ -1,5 +1,6 @@
 | 
			
		||||
---
 | 
			
		||||
link: /enterprise-dashboard/umn/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: umn/source
 | 
			
		||||
service_type: ed
 | 
			
		||||
title: User Guide
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: api/eip
 | 
			
		||||
html_location: docs/eip/api-ref
 | 
			
		||||
link: /elastic-ip/api-ref/
 | 
			
		||||
pdf_name: eip-api-ref
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: api-ref/source
 | 
			
		||||
service_type: eip
 | 
			
		||||
title: API Reference
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: usermanual/eip
 | 
			
		||||
html_location: docs/eip/umn
 | 
			
		||||
link: /elastic-ip/umn/
 | 
			
		||||
pdf_name: eip-umn
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: umn/source
 | 
			
		||||
service_type: eip
 | 
			
		||||
title: User Guide
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: api/elb
 | 
			
		||||
html_location: docs/elb/api-ref
 | 
			
		||||
link: /elastic-load-balancing/api-ref/
 | 
			
		||||
pdf_name: elb-api-ref
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: api-ref/source
 | 
			
		||||
service_type: elb
 | 
			
		||||
title: API Reference
 | 
			
		||||
 | 
			
		||||
@ -3,7 +3,7 @@ hc_location: bestpractice/elb
 | 
			
		||||
environment: internal
 | 
			
		||||
html_location: docs/elb/best-practice
 | 
			
		||||
link: /elastic-load-balancing/best-practice/
 | 
			
		||||
pdf_name: elb-best-practice
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: elb
 | 
			
		||||
title: Best Practice
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: usermanual/elb
 | 
			
		||||
html_location: docs/elb/umn
 | 
			
		||||
link: /elastic-load-balancing/umn/
 | 
			
		||||
pdf_name: elb-umn
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: umn/source
 | 
			
		||||
service_type: elb
 | 
			
		||||
title: User Guide
 | 
			
		||||
 | 
			
		||||
@ -3,7 +3,7 @@ environment: internal
 | 
			
		||||
hc_location: api/em
 | 
			
		||||
html_location: docs/eps/api-ref
 | 
			
		||||
link: /enterprise-project-service/api-ref/
 | 
			
		||||
pdf_name: eps-api-ref
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: api-ref/source
 | 
			
		||||
service_type: eps
 | 
			
		||||
title: API Reference
 | 
			
		||||
 | 
			
		||||
@ -3,7 +3,7 @@ environment: internal
 | 
			
		||||
hc_location: usermanual/em
 | 
			
		||||
html_location: docs/eps/umn
 | 
			
		||||
link: /enterprise-project-service/umn/
 | 
			
		||||
pdf_name: eps-umn
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: umn/source
 | 
			
		||||
service_type: eps
 | 
			
		||||
title: User Guide
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: api/er
 | 
			
		||||
html_location: docs/er/api-ref
 | 
			
		||||
link: /enterprise-router/api-ref/
 | 
			
		||||
pdf_name: er-api-ref
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: api-ref/source
 | 
			
		||||
service_type: er
 | 
			
		||||
title: API Reference
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: usermanual/er
 | 
			
		||||
html_location: docs/er/umn
 | 
			
		||||
link: /enterprise-router/umn/
 | 
			
		||||
pdf_name: er-umn
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: umn/source
 | 
			
		||||
service_type: er
 | 
			
		||||
title: User Guide
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: api/evs
 | 
			
		||||
html_location: docs/evs/api-ref
 | 
			
		||||
link: /elastic-volume-service/api-ref/
 | 
			
		||||
pdf_name: evs-api-ref
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: api-ref/source
 | 
			
		||||
service_type: evs
 | 
			
		||||
title: API Reference
 | 
			
		||||
 | 
			
		||||
@ -3,7 +3,7 @@ hc_location: bestpractice/evs
 | 
			
		||||
environment: internal
 | 
			
		||||
html_location: docs/evs/best-practice
 | 
			
		||||
link: /elastic-volume-service/best-practice/
 | 
			
		||||
pdf_name: evs-best-practice
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: evs
 | 
			
		||||
title: Best Practice
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: devg/evs
 | 
			
		||||
html_location: docs/evs/dev
 | 
			
		||||
link: /elastic-volume-service/dev-guide/
 | 
			
		||||
pdf_name: evs-dev-guide
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: dev_guide/source
 | 
			
		||||
service_type: evs
 | 
			
		||||
title: Developer Guide
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: usermanual/evs
 | 
			
		||||
html_location: docs/evs/umn
 | 
			
		||||
link: /elastic-volume-service/umn/
 | 
			
		||||
pdf_name: evs-umn
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: umn/source
 | 
			
		||||
service_type: evs
 | 
			
		||||
title: User Guide
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: api/functiongraph
 | 
			
		||||
html_location: docs/fg/api-ref
 | 
			
		||||
link: /function-graph/api-ref/
 | 
			
		||||
pdf_name: fg-api-ref
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: api-ref/source
 | 
			
		||||
service_type: fg
 | 
			
		||||
title: API Reference
 | 
			
		||||
 | 
			
		||||
@ -3,7 +3,7 @@ hc_location: bestpractice/functiongraph
 | 
			
		||||
environment: internal
 | 
			
		||||
html_location: docs/fg/best-practice
 | 
			
		||||
link: /function-graph/best-practice/
 | 
			
		||||
pdf_name: fg-best-practice
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: fg
 | 
			
		||||
title: Best Practice
 | 
			
		||||
 | 
			
		||||
@ -3,7 +3,7 @@ hc_location: devg/functiongraph
 | 
			
		||||
environment: internal
 | 
			
		||||
html_location: docs/fg/dev
 | 
			
		||||
link: /function-graph/dev-guide/
 | 
			
		||||
pdf_name: fg-dev-guide
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: dev_guide/source
 | 
			
		||||
service_type: fg
 | 
			
		||||
title: Developer Guide
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: usermanual/functiongraph
 | 
			
		||||
html_location: docs/fg/umn
 | 
			
		||||
link: /function-graph/umn/
 | 
			
		||||
pdf_name: fg-umn
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: umn/source
 | 
			
		||||
service_type: fg
 | 
			
		||||
title: User Guide
 | 
			
		||||
 | 
			
		||||
@ -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
 | 
			
		||||
 | 
			
		||||
@ -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
 | 
			
		||||
 | 
			
		||||
@ -126,9 +126,9 @@ html_copy_source = False
 | 
			
		||||
 | 
			
		||||
# -- Options for PDF output --------------------------------------------------
 | 
			
		||||
latex_documents = [
 | 
			
		||||
{%- if pdf_name is defined %}
 | 
			
		||||
{%- if doc_type %}
 | 
			
		||||
    ('index',
 | 
			
		||||
     '{{ pdf_name }}.tex',
 | 
			
		||||
     '{{ service_type }}-{{ doc_type }}.tex',
 | 
			
		||||
     u'{{ title }}',
 | 
			
		||||
     u'OpenTelekomCloud', 'manual'),
 | 
			
		||||
{% endif -%}
 | 
			
		||||
 | 
			
		||||
@ -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 %}
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
@ -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
 | 
			
		||||
 | 
			
		||||
@ -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")
 | 
			
		||||
 | 
			
		||||
		Reference in New Issue
	
	Block a user