Compare commits
	
		
			2 Commits
		
	
	
		
			enable_pdf
			...
			pc-apiref
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| 1a93f6d9cb | |||
| 968799fd60 | 
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: api/dbss
 | 
			
		||||
html_location: docs/dbss/api-ref
 | 
			
		||||
link: /database-security-service/api-ref/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
pdf_name: dbss-api-ref
 | 
			
		||||
rst_location: api-ref/source
 | 
			
		||||
service_type: dbss
 | 
			
		||||
title: API Reference
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: usermanual/dbss
 | 
			
		||||
html_location: docs/dbss/umn
 | 
			
		||||
link: /database-security-service/umn/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
pdf_name: dbss-umn
 | 
			
		||||
rst_location: umn/source
 | 
			
		||||
service_type: dbss
 | 
			
		||||
title: User Guide
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: api/dc
 | 
			
		||||
html_location: docs/dc/api-ref
 | 
			
		||||
link: /direct-connect/api-ref/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
pdf_name: dc-api-ref
 | 
			
		||||
rst_location: api-ref/source
 | 
			
		||||
service_type: dc
 | 
			
		||||
title: API Reference
 | 
			
		||||
 | 
			
		||||
@ -3,7 +3,7 @@ hc_location: bestpractice/dc
 | 
			
		||||
environment: internal
 | 
			
		||||
html_location: docs/dc/best-practice
 | 
			
		||||
link: /direct-connect/best-practice/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
pdf_name: dc-best-practice
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: dc
 | 
			
		||||
title: Best Practice
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: usermanual/dc
 | 
			
		||||
html_location: docs/dc/umn
 | 
			
		||||
link: /direct-connect/umn/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
pdf_name: dc-umn
 | 
			
		||||
rst_location: umn/source
 | 
			
		||||
service_type: dc
 | 
			
		||||
title: User Guide
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: api/dcs
 | 
			
		||||
html_location: docs/dcs/api-ref
 | 
			
		||||
link: /distributed-cache-service/api-ref/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
pdf_name: dcs-api-ref
 | 
			
		||||
rst_location: api-ref/source
 | 
			
		||||
service_type: dcs
 | 
			
		||||
title: API Reference
 | 
			
		||||
 | 
			
		||||
@ -3,7 +3,7 @@ hc_location: bestpractice/dcs
 | 
			
		||||
environment: internal
 | 
			
		||||
html_location: docs/dcs/best-practice
 | 
			
		||||
link: /distributed-cache-service/best-practice/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
pdf_name: dcs-best-practice
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: dcs
 | 
			
		||||
title: Best Practice
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: usermanual/dcs
 | 
			
		||||
html_location: docs/dcs/umn
 | 
			
		||||
link: /distributed-cache-service/umn/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
pdf_name: dcs-umn
 | 
			
		||||
rst_location: umn/source
 | 
			
		||||
service_type: dcs
 | 
			
		||||
title: User Guide
 | 
			
		||||
 | 
			
		||||
@ -3,7 +3,7 @@ hc_location: api/ddm
 | 
			
		||||
environment: public
 | 
			
		||||
html_location: docs/ddm/api-ref
 | 
			
		||||
link: /distributed-database-middleware/api-ref/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
pdf_name: ddm-api-ref
 | 
			
		||||
rst_location: api-ref/source
 | 
			
		||||
service_type: ddm
 | 
			
		||||
title: API Reference
 | 
			
		||||
 | 
			
		||||
@ -3,7 +3,7 @@ hc_location: usermanual/ddm
 | 
			
		||||
environment: public
 | 
			
		||||
html_location: docs/ddm/umn
 | 
			
		||||
link: /distributed-database-middleware/umn/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
pdf_name: ddm-umn
 | 
			
		||||
rst_location: umn/source
 | 
			
		||||
service_type: ddm
 | 
			
		||||
title: User Guide
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,6 @@
 | 
			
		||||
hc_location: api/dds
 | 
			
		||||
html_location: docs/dds/api-ref
 | 
			
		||||
link: /document-database-service/api-ref/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
rst_location: api-ref/source
 | 
			
		||||
service_type: dds
 | 
			
		||||
title: API Reference
 | 
			
		||||
 | 
			
		||||
@ -3,7 +3,7 @@ hc_location: bestpractice/dds
 | 
			
		||||
environment: internal
 | 
			
		||||
html_location: docs/dds/best-practice
 | 
			
		||||
link: /document-database-service/best-practice/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
pdf_name: dds-best-practice
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: dds
 | 
			
		||||
title: Best Practice
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: usermanual/dds
 | 
			
		||||
html_location: docs/dds/umn
 | 
			
		||||
link: /document-database-service/umn/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
pdf_name: dds-umn
 | 
			
		||||
rst_location: umn/source
 | 
			
		||||
service_type: dds
 | 
			
		||||
title: User Guide
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: api/deh
 | 
			
		||||
html_location: docs/deh/api-ref
 | 
			
		||||
link: /dedicated-host/api-ref/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
pdf_name: deh-api-ref
 | 
			
		||||
rst_location: api-ref/source
 | 
			
		||||
service_type: deh
 | 
			
		||||
title: API Reference
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: usermanual/deh
 | 
			
		||||
html_location: docs/deh/umn
 | 
			
		||||
link: /dedicated-host/umn/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
pdf_name: deh-umn
 | 
			
		||||
rst_location: umn/source
 | 
			
		||||
service_type: deh
 | 
			
		||||
title: User Guide
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: api/dis
 | 
			
		||||
html_location: docs/dis/api-ref
 | 
			
		||||
link: /data-ingestion-service/api-ref/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
pdf_name: dis-api-ref
 | 
			
		||||
rst_location: api-ref/source
 | 
			
		||||
service_type: dis
 | 
			
		||||
title: API Reference
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: usermanual/dis
 | 
			
		||||
html_location: docs/dis/umn
 | 
			
		||||
link: /data-ingestion-service/umn/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
pdf_name: dis-umn
 | 
			
		||||
rst_location: umn/source
 | 
			
		||||
service_type: dis
 | 
			
		||||
title: User Guide
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: api/dli
 | 
			
		||||
html_location: docs/dli/api-ref
 | 
			
		||||
link: /data-lake-insight/api-ref/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
pdf_name: dli-api-ref
 | 
			
		||||
rst_location: api-ref/source
 | 
			
		||||
service_type: dli
 | 
			
		||||
title: API Reference
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: devg/dli
 | 
			
		||||
html_location: docs/dli/dev
 | 
			
		||||
link: /data-lake-insight/dev-guide/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
pdf_name: dli-dev-guide
 | 
			
		||||
rst_location: dev_guide/source
 | 
			
		||||
service_type: dli
 | 
			
		||||
title: Developer Guide
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: sqlreference/dli
 | 
			
		||||
html_location: docs/dli/sqlreference
 | 
			
		||||
link: /data-lake-insight/sqlreference/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
pdf_name: dli-sqlreference
 | 
			
		||||
rst_location: doc/sqlreference/source
 | 
			
		||||
service_type: dli
 | 
			
		||||
title: Sql Syntax Reference
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: usermanual/dli
 | 
			
		||||
html_location: docs/dli/umn
 | 
			
		||||
link: /data-lake-insight/umn/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
pdf_name: dli-umn
 | 
			
		||||
rst_location: umn/source
 | 
			
		||||
service_type: dli
 | 
			
		||||
title: User Guide
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: api/dms
 | 
			
		||||
html_location: docs/dms/api-ref
 | 
			
		||||
link: /distributed-message-service/api-ref/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
pdf_name: dms-api-ref
 | 
			
		||||
rst_location: api-ref/source
 | 
			
		||||
service_type: dms
 | 
			
		||||
title: API Reference
 | 
			
		||||
 | 
			
		||||
@ -3,7 +3,7 @@ hc_location: bestpractice/dms
 | 
			
		||||
environment: internal
 | 
			
		||||
html_location: docs/dms/best-practice
 | 
			
		||||
link: /distributed-message-service/best-practice/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
pdf_name: dms-best-practice
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: dms
 | 
			
		||||
title: Best Practice
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: devg/dms
 | 
			
		||||
html_location: docs/dms/dev
 | 
			
		||||
link: /distributed-message-service/dev-guide/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
pdf_name: dms-dev-guide
 | 
			
		||||
rst_location: dev_guide/source
 | 
			
		||||
service_type: dms
 | 
			
		||||
title: Developer Guide
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: usermanual/dms
 | 
			
		||||
html_location: docs/dms/umn
 | 
			
		||||
link: /distributed-message-service/umn/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
pdf_name: dms-umn
 | 
			
		||||
rst_location: umn/source
 | 
			
		||||
service_type: dms
 | 
			
		||||
title: User Guide
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: api/dns
 | 
			
		||||
html_location: docs/dns/api-ref
 | 
			
		||||
link: /domain-name-service/api-ref/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
pdf_name: dns-api-ref
 | 
			
		||||
rst_location: api-ref/source
 | 
			
		||||
service_type: dns
 | 
			
		||||
title: API Reference
 | 
			
		||||
 | 
			
		||||
@ -3,7 +3,7 @@ hc_location: bestpractice/dns
 | 
			
		||||
environment: internal
 | 
			
		||||
html_location: docs/dns/best-practice
 | 
			
		||||
link: /domain-name-service/best-practice/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
pdf_name: dns-best-practice
 | 
			
		||||
rst_location: doc/best-practice/source
 | 
			
		||||
service_type: dns
 | 
			
		||||
title: Best Practice
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: usermanual/dns
 | 
			
		||||
html_location: docs/dns/umn
 | 
			
		||||
link: /domain-name-service/umn/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
pdf_name: dns-umn
 | 
			
		||||
rst_location: umn/source
 | 
			
		||||
service_type: dns
 | 
			
		||||
title: User Guide
 | 
			
		||||
 | 
			
		||||
@ -2,7 +2,7 @@
 | 
			
		||||
hc_location: api/nosql
 | 
			
		||||
html_location: docs/geminidb/api-ref
 | 
			
		||||
link: /geminidb/api-ref/
 | 
			
		||||
pdf_enabled: true
 | 
			
		||||
pdf_name: geminidb-api-ref
 | 
			
		||||
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_enabled: true
 | 
			
		||||
pdf_name: geminidb-umn
 | 
			
		||||
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 doc_type %}
 | 
			
		||||
{%- if pdf_name is defined %}
 | 
			
		||||
    ('index',
 | 
			
		||||
     '{{ service_type }}-{{ doc_type }}.tex',
 | 
			
		||||
     '{{ pdf_name }}.tex',
 | 
			
		||||
     u'{{ title }}',
 | 
			
		||||
     u'OpenTelekomCloud', 'manual'),
 | 
			
		||||
{% endif -%}
 | 
			
		||||
 | 
			
		||||
@ -44,7 +44,7 @@ commands =
 | 
			
		||||
  {[testenv:json-{{ doc.type }}]commands}
 | 
			
		||||
{%- endfor %}
 | 
			
		||||
 | 
			
		||||
[testenv:pdf-docs]
 | 
			
		||||
[testenv:docs-pdf]
 | 
			
		||||
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_enabled %}
 | 
			
		||||
{%- if doc.pdf_name %}
 | 
			
		||||
  {[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_enabled -%}
 | 
			
		||||
{% if doc.pdf_name -%}
 | 
			
		||||
# 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/{{ service_type }}-{{ doc.type }}.pdf doc/build/pdf/
 | 
			
		||||
  cp {{ loc }}/build/pdf/{{ doc.pdf_name }}.pdf doc/build/pdf/
 | 
			
		||||
{% endif %}
 | 
			
		||||
{% endfor %}
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
@ -4,13 +4,6 @@
 | 
			
		||||
    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,7 +276,6 @@ 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")
 | 
			
		||||
@ -300,12 +299,6 @@ 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