Compare commits
4 Commits
enable_pdf
...
e311115502
Author | SHA1 | Date | |
---|---|---|---|
e311115502 | |||
919d54f8d3 | |||
016b67221c | |||
a7ee45b3d8 |
@ -2,7 +2,7 @@
|
|||||||
hc_location: api2/cce
|
hc_location: api2/cce
|
||||||
html_location: docs/cce/api-ref
|
html_location: docs/cce/api-ref
|
||||||
link: /cloud-container-engine/api-ref/
|
link: /cloud-container-engine/api-ref/
|
||||||
pdf_name: cce-api-ref
|
pdf_enabled: true
|
||||||
rst_location: api-ref/source
|
rst_location: api-ref/source
|
||||||
service_type: cce
|
service_type: cce
|
||||||
title: API Reference
|
title: API Reference
|
||||||
|
@ -3,7 +3,7 @@ hc_location: bestpractice/cce
|
|||||||
environment: internal
|
environment: internal
|
||||||
html_location: docs/cce/best-practice
|
html_location: docs/cce/best-practice
|
||||||
link: /cloud-container-engine/best-practice/
|
link: /cloud-container-engine/best-practice/
|
||||||
pdf_name: cce-best-practice
|
pdf_enabled: true
|
||||||
rst_location: doc/best-practice/source
|
rst_location: doc/best-practice/source
|
||||||
service_type: cce
|
service_type: cce
|
||||||
title: Best Practice
|
title: Best Practice
|
||||||
|
@ -2,6 +2,7 @@
|
|||||||
hc_location: usermanual2/cce
|
hc_location: usermanual2/cce
|
||||||
html_location: docs/cce/umn
|
html_location: docs/cce/umn
|
||||||
link: /cloud-container-engine/umn/
|
link: /cloud-container-engine/umn/
|
||||||
|
pdf_enabled: true
|
||||||
rst_location: umn/source
|
rst_location: umn/source
|
||||||
service_type: cce
|
service_type: cce
|
||||||
title: User Guide
|
title: User Guide
|
||||||
|
@ -3,7 +3,7 @@ hc_location: api/cci
|
|||||||
environment: public
|
environment: public
|
||||||
html_location: docs/cci/api-ref
|
html_location: docs/cci/api-ref
|
||||||
link: /cloud-container-instance/api-ref/
|
link: /cloud-container-instance/api-ref/
|
||||||
pdf_name: cci-api-ref
|
pdf_enabled: true
|
||||||
rst_location: api-ref/source
|
rst_location: api-ref/source
|
||||||
service_type: cci
|
service_type: cci
|
||||||
title: API Reference
|
title: API Reference
|
||||||
|
@ -3,7 +3,7 @@ hc_location: usermanual/cci
|
|||||||
environment: public
|
environment: public
|
||||||
html_location: docs/cci/umn
|
html_location: docs/cci/umn
|
||||||
link: /cloud-container-instance/umn/
|
link: /cloud-container-instance/umn/
|
||||||
pdf_name: cci-umn
|
pdf_enabled: true
|
||||||
rst_location: umn/source
|
rst_location: umn/source
|
||||||
service_type: cci
|
service_type: cci
|
||||||
title: User Guide
|
title: User Guide
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
hc_location: api/ces
|
hc_location: api/ces
|
||||||
html_location: docs/ces/api-ref
|
html_location: docs/ces/api-ref
|
||||||
link: /cloud-eye/api-ref/
|
link: /cloud-eye/api-ref/
|
||||||
pdf_name: ces-api-ref
|
pdf_enabled: true
|
||||||
rst_location: api-ref/source
|
rst_location: api-ref/source
|
||||||
service_type: ces
|
service_type: ces
|
||||||
title: API Reference
|
title: API Reference
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
hc_location: usermanual/ces
|
hc_location: usermanual/ces
|
||||||
html_location: docs/ces/umn
|
html_location: docs/ces/umn
|
||||||
link: /cloud-eye/umn/
|
link: /cloud-eye/umn/
|
||||||
pdf_name: ces-umn
|
pdf_enabled: true
|
||||||
rst_location: umn/source
|
rst_location: umn/source
|
||||||
service_type: ces
|
service_type: ces
|
||||||
title: User Guide
|
title: User Guide
|
||||||
|
@ -3,7 +3,7 @@ environment: internal
|
|||||||
hc_location: api/cfw
|
hc_location: api/cfw
|
||||||
html_location: docs/cfw/api-ref
|
html_location: docs/cfw/api-ref
|
||||||
link: /cloud-firewall/api-ref/
|
link: /cloud-firewall/api-ref/
|
||||||
pdf_name: cfw-api-ref
|
pdf_enabled: true
|
||||||
rst_location: api-ref/source
|
rst_location: api-ref/source
|
||||||
service_type: cfw
|
service_type: cfw
|
||||||
title: API Reference
|
title: API Reference
|
||||||
|
@ -3,7 +3,7 @@ environment: internal
|
|||||||
hc_location: usermanual/cfw
|
hc_location: usermanual/cfw
|
||||||
html_location: docs/cfw/umn
|
html_location: docs/cfw/umn
|
||||||
link: /cloud-firewall/umn/
|
link: /cloud-firewall/umn/
|
||||||
pdf_name: cfw-umn
|
pdf_enabled: true
|
||||||
rst_location: umn/source
|
rst_location: umn/source
|
||||||
service_type: cfw
|
service_type: cfw
|
||||||
title: User Guide
|
title: User Guide
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
hc_location: api/rms
|
hc_location: api/rms
|
||||||
html_location: docs/config/api-ref
|
html_location: docs/config/api-ref
|
||||||
link: /config/api-ref/
|
link: /config/api-ref/
|
||||||
pdf_name: config-api-ref
|
pdf_enabled: true
|
||||||
rst_location: api-ref/source
|
rst_location: api-ref/source
|
||||||
service_type: config
|
service_type: config
|
||||||
title: API Reference
|
title: API Reference
|
||||||
|
@ -2,6 +2,7 @@
|
|||||||
hc_location: usermanual/rms
|
hc_location: usermanual/rms
|
||||||
html_location: docs/config/umn
|
html_location: docs/config/umn
|
||||||
link: /config/umn/
|
link: /config/umn/
|
||||||
|
pdf_enabled: true
|
||||||
rst_location: umn/source
|
rst_location: umn/source
|
||||||
service_type: config
|
service_type: config
|
||||||
title: User Guide
|
title: User Guide
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
hc_location: api/csbs
|
hc_location: api/csbs
|
||||||
html_location: docs/csbs/api-ref
|
html_location: docs/csbs/api-ref
|
||||||
link: /cloud-server-backup-service/api-ref/
|
link: /cloud-server-backup-service/api-ref/
|
||||||
pdf_name: csbs-api-ref
|
pdf_enabled: true
|
||||||
rst_location: api-ref/source
|
rst_location: api-ref/source
|
||||||
service_type: csbs
|
service_type: csbs
|
||||||
title: API Reference
|
title: API Reference
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
hc_location: usermanual/csbs
|
hc_location: usermanual/csbs
|
||||||
html_location: docs/csbs/umn
|
html_location: docs/csbs/umn
|
||||||
link: /cloud-server-backup-service/umn/
|
link: /cloud-server-backup-service/umn/
|
||||||
pdf_name: csbs-umn
|
pdf_enabled: true
|
||||||
rst_location: umn/source
|
rst_location: umn/source
|
||||||
service_type: csbs
|
service_type: csbs
|
||||||
title: User Guide
|
title: User Guide
|
||||||
|
@ -3,7 +3,7 @@ hc_location: api/cse
|
|||||||
environment: internal
|
environment: internal
|
||||||
html_location: docs/cse/api-ref
|
html_location: docs/cse/api-ref
|
||||||
link: /cloud-service-engine/api-ref/
|
link: /cloud-service-engine/api-ref/
|
||||||
pdf_name: cse-api-ref
|
pdf_enabled: true
|
||||||
rst_location: api-ref/source
|
rst_location: api-ref/source
|
||||||
service_type: cse
|
service_type: cse
|
||||||
title: API Reference
|
title: API Reference
|
||||||
|
@ -3,7 +3,7 @@ hc_location: usermanual/cse
|
|||||||
environment: internal
|
environment: internal
|
||||||
html_location: docs/cse/umn
|
html_location: docs/cse/umn
|
||||||
link: /cloud-service-engine/umn/
|
link: /cloud-service-engine/umn/
|
||||||
pdf_name: cse-umn
|
pdf_enabled: true
|
||||||
rst_location: umn/source
|
rst_location: umn/source
|
||||||
service_type: cse
|
service_type: cse
|
||||||
title: User Guide
|
title: User Guide
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
hc_location: api/css
|
hc_location: api/css
|
||||||
html_location: docs/css/api-ref
|
html_location: docs/css/api-ref
|
||||||
link: /cloud-search-service/api-ref/
|
link: /cloud-search-service/api-ref/
|
||||||
pdf_name: css-api-ref
|
pdf_enabled: true
|
||||||
rst_location: api-ref/source
|
rst_location: api-ref/source
|
||||||
service_type: css
|
service_type: css
|
||||||
title: API Reference
|
title: API Reference
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
hc_location: bestpractice/css
|
hc_location: bestpractice/css
|
||||||
html_location: docs/css/best-practice
|
html_location: docs/css/best-practice
|
||||||
link: /cloud-search-service/best-practice/
|
link: /cloud-search-service/best-practice/
|
||||||
pdf_name: css-best-practice
|
pdf_enabled: true
|
||||||
rst_location: doc/best-practice/source
|
rst_location: doc/best-practice/source
|
||||||
service_type: css
|
service_type: css
|
||||||
title: Best Practice
|
title: Best Practice
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
hc_location: usermanual/css
|
hc_location: usermanual/css
|
||||||
html_location: docs/css/umn
|
html_location: docs/css/umn
|
||||||
link: /cloud-search-service/umn/
|
link: /cloud-search-service/umn/
|
||||||
pdf_name: css-umn
|
pdf_enabled: true
|
||||||
rst_location: umn/source
|
rst_location: umn/source
|
||||||
service_type: css
|
service_type: css
|
||||||
title: User Guide
|
title: User Guide
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
hc_location: api/cts
|
hc_location: api/cts
|
||||||
html_location: docs/cts/api-ref
|
html_location: docs/cts/api-ref
|
||||||
link: /cloud-trace-service/api-ref/
|
link: /cloud-trace-service/api-ref/
|
||||||
pdf_name: cts-api-ref
|
pdf_enabled: true
|
||||||
rst_location: api-ref/source
|
rst_location: api-ref/source
|
||||||
service_type: cts
|
service_type: cts
|
||||||
title: API Reference
|
title: API Reference
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
hc_location: usermanual/cts
|
hc_location: usermanual/cts
|
||||||
html_location: docs/cts/umn
|
html_location: docs/cts/umn
|
||||||
link: /cloud-trace-service/umn/
|
link: /cloud-trace-service/umn/
|
||||||
pdf_name: cts-umn
|
pdf_enabled: true
|
||||||
rst_location: umn/source
|
rst_location: umn/source
|
||||||
service_type: cts
|
service_type: cts
|
||||||
title: User Guide
|
title: User Guide
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
hc_location: api/dataartsstudio
|
hc_location: api/dataartsstudio
|
||||||
html_location: docs/dataartsstudio/api-ref
|
html_location: docs/dataartsstudio/api-ref
|
||||||
link: /data-arts-studio/api-ref/
|
link: /data-arts-studio/api-ref/
|
||||||
pdf_name: dataarts_studio-api-ref
|
pdf_enabled: true
|
||||||
rst_location: api-ref/source
|
rst_location: api-ref/source
|
||||||
service_type: dataarts_studio
|
service_type: dataarts_studio
|
||||||
title: API Reference
|
title: API Reference
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
hc_location: usermanual/dataartsstudio
|
hc_location: usermanual/dataartsstudio
|
||||||
html_location: docs/dataartsstudio/umn
|
html_location: docs/dataartsstudio/umn
|
||||||
link: /data-arts-studio/umn/
|
link: /data-arts-studio/umn/
|
||||||
pdf_name: dataarts_studio-umn
|
pdf_enabled: true
|
||||||
rst_location: umn/source
|
rst_location: umn/source
|
||||||
service_type: dataarts_studio
|
service_type: dataarts_studio
|
||||||
title: User Guide
|
title: User Guide
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
hc_location: api/nosql
|
hc_location: api/nosql
|
||||||
html_location: docs/geminidb/api-ref
|
html_location: docs/geminidb/api-ref
|
||||||
link: /geminidb/api-ref/
|
link: /geminidb/api-ref/
|
||||||
pdf_name: geminidb-api-ref
|
pdf_enabled: true
|
||||||
rst_location: api-ref/source
|
rst_location: api-ref/source
|
||||||
service_type: geminidb
|
service_type: geminidb
|
||||||
title: API Reference
|
title: API Reference
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
hc_location: usermanual/nosql
|
hc_location: usermanual/nosql
|
||||||
html_location: docs/geminidb/umn
|
html_location: docs/geminidb/umn
|
||||||
link: /geminidb/umn/
|
link: /geminidb/umn/
|
||||||
pdf_name: geminidb-umn
|
pdf_enabled: true
|
||||||
rst_location: umn/source
|
rst_location: umn/source
|
||||||
service_type: geminidb
|
service_type: geminidb
|
||||||
title: User Guide
|
title: User Guide
|
||||||
|
@ -126,9 +126,9 @@ html_copy_source = False
|
|||||||
|
|
||||||
# -- Options for PDF output --------------------------------------------------
|
# -- Options for PDF output --------------------------------------------------
|
||||||
latex_documents = [
|
latex_documents = [
|
||||||
{%- if pdf_name is defined %}
|
{%- if doc_type %}
|
||||||
('index',
|
('index',
|
||||||
'{{ pdf_name }}.tex',
|
'{{ service_type }}-{{ doc_type }}.tex',
|
||||||
u'{{ title }}',
|
u'{{ title }}',
|
||||||
u'OpenTelekomCloud', 'manual'),
|
u'OpenTelekomCloud', 'manual'),
|
||||||
{% endif -%}
|
{% endif -%}
|
||||||
|
@ -44,7 +44,7 @@ commands =
|
|||||||
{[testenv:json-{{ doc.type }}]commands}
|
{[testenv:json-{{ doc.type }}]commands}
|
||||||
{%- endfor %}
|
{%- endfor %}
|
||||||
|
|
||||||
[testenv:docs-pdf]
|
[testenv:pdf-docs]
|
||||||
deps =
|
deps =
|
||||||
{[testenv:docs]deps}
|
{[testenv:docs]deps}
|
||||||
{[testenv:bindeps]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/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
|
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 %}
|
{%- for doc in docs %}
|
||||||
{%- if doc.pdf_name %}
|
{%- if doc.pdf_enabled %}
|
||||||
{[testenv:{{ doc.type }}-pdf-docs]commands}
|
{[testenv:{{ doc.type }}-pdf-docs]commands}
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
{%- endfor %}
|
{%- endfor %}
|
||||||
@ -107,7 +107,7 @@ commands =
|
|||||||
cp -av doc/build/json/{{ doc.type }} {{ doc.type }}/build/json
|
cp -av doc/build/json/{{ doc.type }} {{ doc.type }}/build/json
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
|
|
||||||
{% if doc.pdf_name -%}
|
{% if doc.pdf_enabled -%}
|
||||||
# PDF version
|
# PDF version
|
||||||
[testenv:{{ doc.type }}-pdf-docs]
|
[testenv:{{ doc.type }}-pdf-docs]
|
||||||
deps = {[testenv:docs]deps}
|
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"
|
bash -c "for f in {{ loc }}/build/pdf/*.tex; do sed -iorig 's/\.gif//g' $f; done"
|
||||||
make -C {{ loc }}/build/pdf
|
make -C {{ loc }}/build/pdf
|
||||||
mkdir -p doc/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 %}
|
{% endif %}
|
||||||
{% endfor %}
|
{% endfor %}
|
||||||
|
|
||||||
|
@ -4,6 +4,13 @@
|
|||||||
default-branch: main
|
default-branch: main
|
||||||
templates:
|
templates:
|
||||||
- helpcenter-base-jobs
|
- helpcenter-base-jobs
|
||||||
|
vars:
|
||||||
|
sphinx_pdf_files:
|
||||||
|
{%- for doc in docs %}
|
||||||
|
{%- if doc.pdf_enabled %}
|
||||||
|
- {{ service_type }}-{{ doc.type }}.pdf
|
||||||
|
{%- endif %}
|
||||||
|
{%- endfor %}
|
||||||
check:
|
check:
|
||||||
jobs:
|
jobs:
|
||||||
- noop
|
- noop
|
||||||
|
@ -276,6 +276,7 @@ def process_repositories(args, service):
|
|||||||
context["docs"].append(doc)
|
context["docs"].append(doc)
|
||||||
|
|
||||||
context["target_environment"] = args.target_environment
|
context["target_environment"] = args.target_environment
|
||||||
|
context["service_type"] = service['service_type']
|
||||||
|
|
||||||
tox_ini_content = tox_ini_template.render(**context)
|
tox_ini_content = tox_ini_template.render(**context)
|
||||||
tox_ini_path = pathlib.Path(copy_to, "tox.ini")
|
tox_ini_path = pathlib.Path(copy_to, "tox.ini")
|
||||||
@ -299,6 +300,12 @@ def process_repositories(args, service):
|
|||||||
|
|
||||||
if args.update_zuul:
|
if args.update_zuul:
|
||||||
"""Update zuul.yaml"""
|
"""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_content = zuul_yaml_template.render(**context)
|
||||||
zuul_yaml_path = pathlib.Path(copy_to, "zuul.yaml")
|
zuul_yaml_path = pathlib.Path(copy_to, "zuul.yaml")
|
||||||
|
Reference in New Issue
Block a user