Compare commits

..

2 Commits

Author SHA1 Message Date
c8ac912005 Same as on metadata
All checks were successful
gl/check check status: success (c8ac912005a56c6153002cebaff4811769a77db2)
gl/gate gate status: success (c8ac912005a56c6153002cebaff4811769a77db2)
2023-11-15 08:24:14 +00:00
2b99369390 Added sphinx-minify to tox
All checks were successful
gl/check check status: success (2b99369390fd275fce3ca6e82b24b9080255cc6b)
2023-10-16 12:39:03 +00:00
10 changed files with 3 additions and 102 deletions

3
.gitignore vendored
View File

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

View File

@ -1,10 +0,0 @@
---
environment: internal
hc_location: api/lts
html_location: docs/lts/api-ref
link: /log-tank-service/api-ref/
pdf_name: lts-api-ref
rst_location: api-ref/source
service_type: lts
title: API Reference
type: api-ref

View File

@ -1,10 +0,0 @@
---
environment: internal
hc_location: usermanual/lts
html_location: docs/lts/umn
link: /log-tank-service/umn/
pdf_name: lts-umn
rst_location: umn/source
service_type: lts
title: User Guide
type: umn

View File

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

View File

@ -1,16 +0,0 @@
---
environment: internal
repositories:
- environment: internal
repo: docs-swiss/log-tank-service
type: gitea
- environment: public
repo: opentelekomcloud-docs-swiss/log-tank-service
type: github
service_category: md
service_title: Log Tank Service
service_type: lts
service_uri: log-tank-service
teams:
- name: docs-orchestration-rw
permission: write

View File

@ -87,13 +87,10 @@ class Services(object):
res.append(copy.deepcopy(cat)) res.append(copy.deepcopy(cat))
return res return res
def services_by_category(self, category, environment=None): def services_by_category(self, category):
"""List services matching category""" """List services matching category"""
res = [] res = []
for srv in self.all_services: for srv in self.all_services:
if environment:
if "environment" in srv and srv["environment"] != environment:
continue
if srv["service_category"] == category: if srv["service_category"] == category:
res.append(copy.deepcopy(srv)) res.append(copy.deepcopy(srv))
return res return res

View File

@ -1,15 +1,8 @@
sphinx>=2.0.0,!=2.1.0 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
{% if target_environment == 'public' %}
otcdocstheme<2.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 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
setuptools

View File

@ -43,19 +43,15 @@ commands =
{%- endfor %} {%- endfor %}
[testenv:docs-pdf] [testenv:docs-pdf]
deps = deps = {[testenv:docs]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}
@ -122,21 +118,6 @@ 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

@ -1,12 +0,0 @@
---
- project:
merge-mode: squash-merge
default-branch: main
templates:
- helpcenter-swiss-base-jobs
check:
jobs:
- noop
gate:
jobs:
- noop

View File

@ -50,7 +50,6 @@ def process_repositories(args, service):
) )
conf_py_template = env.get_template("conf.py.j2") conf_py_template = env.get_template("conf.py.j2")
tox_ini_template = env.get_template("tox.ini.j2") tox_ini_template = env.get_template("tox.ini.j2")
zuul_yaml_template = env.get_template("zuul.yaml.j2")
index_sbv_template = env.get_template("index_sbv.rst.j2") index_sbv_template = env.get_template("index_sbv.rst.j2")
doc_requirements_template = env.get_template("doc_requirements.txt.j2") doc_requirements_template = env.get_template("doc_requirements.txt.j2")
@ -248,8 +247,6 @@ 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)
@ -270,16 +267,6 @@ def process_repositories(args, service):
out.write(doc_requirements_content) out.write(doc_requirements_content)
repo_to.index.add(["doc/requirements.txt"]) repo_to.index.add(["doc/requirements.txt"])
if args.update_zuul:
"""Update zuul.yaml"""
zuul_yaml_content = zuul_yaml_template.render(**context)
zuul_yaml_path = pathlib.Path(copy_to, "zuul.yaml")
with open(zuul_yaml_path, "w", encoding="utf-8", newline="") as out:
logging.debug(f"Generating {zuul_yaml_path} from template...")
out.write(zuul_yaml_content)
repo_to.index.add(["zuul.yaml"])
if len(repo_to.index.diff("HEAD")) == 0: if len(repo_to.index.diff("HEAD")) == 0:
# Nothing to commit # Nothing to commit
logging.debug( logging.debug(
@ -336,7 +323,6 @@ 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")
@ -365,11 +351,6 @@ def main():
action="store_true", action="store_true",
help="Whether to update service-based-view" help="Whether to update service-based-view"
) )
parser.add_argument(
"--update-zuul",
action="store_true",
help="Whether to update zuul.yaml"
)
parser.add_argument( parser.add_argument(
"--overwrite-index-sbv", "--overwrite-index-sbv",
action="store_true", action="store_true",