Compare commits

...

5 Commits

Author SHA1 Message Date
7b80f2c53d Added bindep for PDF
All checks were successful
gl/check check status: success (7b80f2c53dd32266d9deb2be9ff3f8c3fd5837b9)
gl/gate gate status: success (7b80f2c53dd32266d9deb2be9ff3f8c3fd5837b9)
2024-01-03 10:52:50 +00:00
bff9eff2bd Differentiate between public and internal otcdocstheme
Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Co-authored-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-committed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
2023-11-15 14:07:16 +00:00
d5e7269ae9 Change category name Database to Databases
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>
2023-11-15 13:49:01 +00:00
1541a02210 Added sphinx-minify to tox
Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Co-authored-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-committed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
2023-11-15 13:48:58 +00:00
96ffbc1403 correct swiss portal name
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>
2023-09-06 12:35:10 +00:00
5 changed files with 48 additions and 20 deletions

3
.gitignore vendored
View File

@ -59,3 +59,6 @@ ChangeLog
# Files created by releasenotes build # Files created by releasenotes build
releasenotes/build releasenotes/build
bindep.txt
packages.txt

View File

@ -1,3 +1,3 @@
--- ---
name: database name: database
title: Database title: Databases

View File

@ -1,7 +1,14 @@
sphinx>=2.0.0,!=2.1.0 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
{% if target_environment == 'public' %}
otcdocstheme<1.0.0 # Apache-2.0
{% elif target_environment == 'internal' %}
otcdocstheme # Apache-2.0 otcdocstheme # Apache-2.0
{% else %}
otcdocstheme # Apache-2.0
{% endif %}
# releasenotes # releasenotes
reno>=3.1.0 # Apache-2.0 reno>=3.1.0 # Apache-2.0
otc-sphinx-directives>=0.1.0 otc-sphinx-directives>=0.1.0
sphinx-minify>=0.0.1 # Apache-2.0
git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata-swiss.git#egg=otc_metadata git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata-swiss.git#egg=otc_metadata

View File

@ -34,23 +34,28 @@ allowlist_externals =
rm rm
sphinx-build sphinx-build
commands = commands =
rm -rf doc/build/html doc/build/doctrees rm -rf doc/build/html doc/build/html_temp doc/build/doctrees
sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html_temp
sphinx-minify --input-directory doc/build/html_temp/ --output-directory doc/build/html
{%- for doc in docs %} {%- for doc in docs %}
{[testenv:{{ doc.type }}]commands} {[testenv:{{ doc.type }}]commands}
{[testenv:json-{{ doc.type }}]commands} {[testenv:json-{{ doc.type }}]commands}
{%- endfor %} {%- endfor %}
[testenv:docs-pdf] [testenv:docs-pdf]
deps = {[testenv:docs]deps} deps =
{[testenv:docs]deps}
{[testenv:bindeps]deps}
allowlist_externals = allowlist_externals =
rm rm
mkdir mkdir
wget
make make
bash bash
cp cp
commands = commands =
mkdir -p doc/build/pdf mkdir -p doc/build/pdf
{[testenv:bindeps]commands}
{%- for doc in docs %} {%- for doc in docs %}
{%- if doc.pdf_name %} {%- if doc.pdf_name %}
{[testenv:{{ doc.type }}-pdf-docs]commands} {[testenv:{{ doc.type }}-pdf-docs]commands}
@ -66,16 +71,14 @@ allowlist_externals =
cp cp
mkdir mkdir
commands = commands =
sphinx-build -W --keep-going -b html {{ loc }}/source doc/build/html/{{ doc.type }} sphinx-build -W --keep-going -b html {{ loc }}/source doc/build/html_temp/{{ doc.type }}
{%- if doc.type == 'api-ref' %} sphinx-minify --input-directory doc/build/html_temp/{{ doc.type }} --output-directory doc/build/html/{{ doc.type }}
mkdir -p api-ref/build/html {%- if doc.type == 'dev-guide' %}
cp -av doc/build/html/api-ref api-ref/build/html
{%- elif doc.type == 'umn' %}
mkdir -p umn/build/html
cp -av doc/build/html/umn umn/build/html
{%- elif doc.type == 'dev-guide' %}
mkdir -p dev_guide/build/html mkdir -p dev_guide/build/html
cp -av doc/build/html/dev-guide dev_guide/build/html cp -av doc/build/html/dev-guide dev_guide/build/html
{%- else %}
mkdir -p {{ doc.type }}/build/html
cp -av doc/build/html/{{ doc.type }} {{ doc.type }}/build/html
{%- endif %} {%- endif %}
# Json version (for search) # Json version (for search)
@ -90,15 +93,12 @@ commands =
# Drop data useless for the search - wrap it also with sh/xargs due to bugs # Drop data useless for the search - wrap it also with sh/xargs due to bugs
# in tox # in tox
sh -c "find doc/build/json -type d -and '(' -name '_images' -or -name '_static' -or -name '_sources' ')' -print0 | xargs -0 rm -rf" sh -c "find doc/build/json -type d -and '(' -name '_images' -or -name '_static' -or -name '_sources' ')' -print0 | xargs -0 rm -rf"
{%- if doc.type == 'api-ref' %} {%- if doc.type == 'dev-guide' %}
mkdir -p api-ref/build/json
cp -av doc/build/json/api-ref api-ref/build/json
{%- elif doc.type == 'umn' %}
mkdir -p umn/build/json
cp -av doc/build/json/umn umn/build/json
{%- elif doc.type == 'dev-guide' %}
mkdir -p dev_guide/build/json mkdir -p dev_guide/build/json
cp -av doc/build/json/dev-guide dev_guide/build/json cp -av doc/build/json/dev-guide dev_guide/build/json
{%- else %}
mkdir -p {{ doc.type }}/build/json
cp -av doc/build/json/{{ doc.type }} {{ doc.type }}/build/json
{%- endif %} {%- endif %}
{% if doc.pdf_name -%} {% if doc.pdf_name -%}
@ -122,6 +122,21 @@ commands =
{% endif %} {% endif %}
{% endfor %} {% endfor %}
[testenv:bindeps]
deps =
bindep
allowlist_externals =
wget
rm
bash
commands =
rm -rf {toxinidir}/bindep.txt
rm -rf {toxinidir}/packages.txt
wget -O {toxinidir}/bindep.txt https://raw.githubusercontent.com/opentelekomcloud/otcdocstheme/main/bindep.txt
bash -c "bindep test -b -f {toxinidir}/bindep.txt > {toxinidir}/packages.txt || true"
bash -c 'if [ -s {toxinidir}/packages.txt ]; then if command -v apt &>/dev/null; then apt update && xargs apt install --no-install-recommends -y < {toxinidir}/packages.txt; fi; fi'
bash -c 'if [ -s {toxinidir}/packages.txt ]; then if command -v dnf &>/dev/null; then dnf install -y $(cat {toxinidir}/packages.txt); fi; fi'
[doc8] [doc8]
ignore = D001 ignore = D001
extensions = .rst, .yaml extensions = .rst, .yaml

View File

@ -207,7 +207,7 @@ def process_repositories(args, service):
) )
else: else:
context["html_options"] = dict( context["html_options"] = dict(
site_name="Open Telekom Cloud Swiss Documentation Portal", site_name="Swiss Open Telekom Cloud Docs",
logo_url="https://docs-beta.sc.otc.t-systems.com", logo_url="https://docs-beta.sc.otc.t-systems.com",
) )
sbv_title = (service["service_title"] + "\n" sbv_title = (service["service_title"] + "\n"
@ -247,6 +247,8 @@ def process_repositories(args, service):
doc["type"] = "dev-guide" doc["type"] = "dev-guide"
context["docs"].append(doc) context["docs"].append(doc)
context["target_environment"] = args.target_environment
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")
doc_requirements_content = doc_requirements_template.render(**context) doc_requirements_content = doc_requirements_template.render(**context)
@ -323,6 +325,7 @@ def main():
parser.add_argument( parser.add_argument(
"--target-environment", "--target-environment",
required=True, required=True,
choices=["internal", "public"],
help="Environment to be used as a source", help="Environment to be used as a source",
) )
parser.add_argument("--service-type", help="Service to update") parser.add_argument("--service-type", help="Service to update")