Compare commits

..

2 Commits

Author SHA1 Message Date
35b2eeb5de fix pep8 issue
All checks were successful
gl/check check status: success (35b2eeb5de4cd1d5be5d7dece9a9f355a8cd6941)
gl/gate gate status: success (35b2eeb5de4cd1d5be5d7dece9a9f355a8cd6941)
2023-10-23 09:37:13 +00:00
b60b9a217f add option in requirements.txt to differentiate environments to stage otcdocstheme releases
Some checks failed
gl/check check status: failure (b60b9a217f8032b222f6c3329a6b446539154da1)
2023-10-23 09:15:04 +00:00
31 changed files with 78 additions and 271 deletions

3
.gitignore vendored
View File

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

View File

@ -1,8 +0,0 @@
---
environment: public
link: /architecture-center/blueprints/
pdf_name: architecture-center-blueprints
rst_location: doc/blueprints/source
service_type: ac
title: Blueprints
type: blueprints

View File

@ -1,8 +0,0 @@
---
environment: public
link: /architecture-center/caf/
pdf_name: architecture-center-cloud-adoption-framework
rst_location: doc/caf/source
service_type: ac
title: Cloud Adoption Framework
type: caf

View File

@ -1,10 +0,0 @@
---
environment: internal
hc_location: api-usage/guidelines
html_location: docs/apiu/guidelines
link: /api-usage/guidelines/
pdf_name: apiu-guidelines
rst_location: doc/guidelines/source
service_type: apiu
title: API Usage Guidelines
type: guidelines

View File

@ -1,10 +0,0 @@
---
hc_location: bestpractice/blueprints
environment: internal
html_location: docs/blueprints/best-practice
link: /blueprints/best-practice/
pdf_name: blueprints-best-practice
rst_location: doc/best-practice/source
service_type: blueprints
title: Best Practice
type: best-practice

View File

@ -1,8 +0,0 @@
---
html_location: docs/cc/api-ref
link: /cloud-create/api-ref/
pdf_name: cc-api-ref
rst_location: api-ref/source
service_type: cc
title: API Reference
type: api-ref

View File

@ -1,8 +0,0 @@
---
html_location: docs/cc/umn
link: /cloud-create/umn/
pdf_name: cc-umn
rst_location: umn/source
service_type: cc
title: User Guide
type: umn

View File

@ -1,10 +0,0 @@
---
environment: internal
hc_location: devg/dli
html_location: docs/dli/dev
link: /data-lake-insight/dev-guide/
pdf_name: dli-dev-guide
rst_location: dev_guide/source
service_type: dli
title: Developer Guide
type: dev

View File

@ -1,9 +0,0 @@
---
hc_location: sqlreference/dli
html_location: docs/dli/sqlreference
link: /data-lake-insight/sqlreference/
pdf_name: dli-sqlreference
rst_location: doc/sqlreference/source
service_type: dli
title: Sql Syntax Reference
type: sqlreference

View File

@ -1,10 +0,0 @@
---
hc_location: bestpractice/drs
environment: internal
html_location: docs/drs/best-practice
link: /data-replication-service/best-practice/
pdf_name: drs-best-practice
rst_location: doc/best-practice/source
service_type: drs
title: Best Practice
type: best-practice

View File

@ -1,6 +1,7 @@
---
hc_location: usermanual/hss2.0
environment: internal
hc_location: usermanual/nosql
html_location: docs/hss/umn
link: /host-security-service/umn/
pdf_name: hss-umn

View File

@ -1,10 +0,0 @@
---
hc_location: bestpractice/ims
environment: internal
html_location: docs/ims/best-practice
link: /image-management-service/best-practice/
pdf_name: ims-best-practice
rst_location: doc/best-practice/source
service_type: ims
title: Best Practice
type: best-practice

View File

@ -1,10 +0,0 @@
---
hc_location: api/ocr
environment: internal
html_location: docs/ocr/api-ref
link: /optical-character-recognition/api-ref/
pdf_name: ocr-api-ref
rst_location: api-ref/source
service_type: ocr
title: API Reference
type: api-ref

View File

@ -1,10 +0,0 @@
---
hc_location: usermanual/ocr
environment: internal
html_location: docs/ocr/umn
link: /optical-character-recognition/umn/
pdf_name: ocr-umn
rst_location: umn/source
service_type: ocr
title: User Guide
type: umn

View File

@ -0,0 +1,9 @@
---
hc_location: api/rts
html_location: docs/rts/api-ref
link: /resource-template-service/api-ref/
pdf_name: rts-api-ref
rst_location: api-ref/source
service_type: rts
title: API Reference
type: api-ref

View File

@ -0,0 +1,9 @@
---
hc_location: usermanual/rts
html_location: docs/rts/umn
link: /resource-template-service/umn/
pdf_name: rts-umn
rst_location: umn/source
service_type: rts
title: User Guide
type: umn

View File

@ -0,0 +1,8 @@
---
html_location: docs/tcc/umn
link: /telekom-cloud-create/umn/
pdf_name: tcc-umn
rst_location: umn/source
service_type: tcc
title: User Guide
type: umn

View File

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

View File

@ -1,16 +0,0 @@
---
environment: hidden
repositories:
- environment: internal
repo: docs/architecture-center
type: gitea
- environment: public
repo: opentelekomcloud-docs/architecture-center
type: github
service_category: other
service_title: Architecture Center
service_type: ac
service_uri: architecture-center
teams:
- name: docs-architecture-center-rw
permission: write

View File

@ -1,16 +0,0 @@
---
environment: internal
repositories:
- environment: internal
repo: docs/api-usage
type: gitea
- environment: public
repo: opentelekomcloud-docs/api-usage
type: github
service_category: other
service_title: API Usage
service_type: apiu
service_uri: api-usage
teams:
- name: eco
permission: write

View File

@ -1,16 +0,0 @@
---
environment: hidden
repositories:
- environment: internal
repo: docs/blueprints
type: gitea
- environment: public
repo: opentelekomcloud-docs/blueprints
type: github
service_category: other
service_title: Blueprints
service_type: blueprints
service_uri: blueprints
teams:
- name: eco
permission: write

View File

@ -1,13 +0,0 @@
---
environment: public
repositories:
- environment: public
repo: opentelekomcloud-docs/cloud-create
type: github
service_category: md
service_title: Cloud Create
service_type: cc
service_uri: cloud-create
teams:
- name: topology-designer-rw
permission: write

View File

@ -1,13 +0,0 @@
---
environment: hidden
repositories:
- environment: public
repo: opentelekomcloud-docs/docs_on_docs
type: github
service_category: other
service_title: Documentation about documentation
service_type: dod
service_uri: docs-on-docs
teams:
- name: docs-eco-rw
permission: write

View File

@ -1,16 +0,0 @@
---
environment: internal
repositories:
- environment: internal
repo: docs/optical-character-recognition
type: gitea
- environment: public
repo: opentelekomcloud-docs/optical-character-recognition
type: github
service_category: big_data
service_title: Optical Character Recognition
service_type: ocr
service_uri: optical-character-recognition
teams:
- name: docs-bigdata-ai-rw
permission: write

View File

@ -0,0 +1,16 @@
---
environment: public
repositories:
- environment: internal
repo: docs/resource-template-service
type: gitea
- environment: public
repo: opentelekomcloud-docs/resource-template-service
type: github
service_category: md
service_title: Resource Template Service
service_type: rts
service_uri: resource-template-service
teams:
- name: docs-orchestration-rw
permission: write

View File

@ -10,7 +10,7 @@ repositories:
service_category: other
service_title: Status Dashboard
service_type: sd
service_uri: status-dashboard
service_uri: status-dashboard/umn
teams:
- name: docs-eco-rw
permission: write

View File

@ -0,0 +1,13 @@
---
environment: hidden
repositories:
- environment: public
repo: opentelekomcloud-docs/telekom-cloud-create
type: github
service_category: other
service_title: Telekom Cloud Create
service_type: tcc
service_uri: telekom-cloud-create
teams:
- name: topology-designer-rw
permission: write

View File

@ -1,6 +1,6 @@
sphinx>=2.0.0,!=2.1.0 # BSD
{% if target_environment == 'public' %}
otcdocstheme<2.0.0 # Apache-2.0
otcdocstheme<1.0.0 # Apache-2.0
{% elif target_environment == 'internal' %}
otcdocstheme # Apache-2.0
{% else %}
@ -10,6 +10,4 @@ otcdocstheme # Apache-2.0
reno>=3.1.0 # Apache-2.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.git#egg=otc_metadata
setuptools
git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata

View File

@ -34,28 +34,23 @@ allowlist_externals =
rm
sphinx-build
commands =
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_temp
sphinx-minify --input-directory doc/build/html_temp/ --output-directory doc/build/html
rm -rf doc/build/html doc/build/doctrees
sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html
{%- for doc in docs %}
{[testenv:{{ doc.type }}]commands}
{[testenv:json-{{ doc.type }}]commands}
{%- endfor %}
[testenv:docs-pdf]
deps =
{[testenv:docs]deps}
{[testenv:bindeps]deps}
deps = {[testenv:docs]deps}
allowlist_externals =
rm
mkdir
wget
make
bash
cp
commands =
mkdir -p doc/build/pdf
{[testenv:bindeps]commands}
{%- for doc in docs %}
{%- if doc.pdf_name %}
{[testenv:{{ doc.type }}-pdf-docs]commands}
@ -71,14 +66,16 @@ allowlist_externals =
cp
mkdir
commands =
sphinx-build -W --keep-going -b html {{ loc }}/source doc/build/html_temp/{{ doc.type }}
sphinx-minify --input-directory doc/build/html_temp/{{ doc.type }} --output-directory doc/build/html/{{ doc.type }}
{%- if doc.type == 'dev-guide' %}
sphinx-build -W --keep-going -b html {{ loc }}/source doc/build/html/{{ doc.type }}
{%- if doc.type == 'api-ref' %}
mkdir -p api-ref/build/html
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
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 %}
# Json version (for search)
@ -93,12 +90,15 @@ commands =
# Drop data useless for the search - wrap it also with sh/xargs due to bugs
# in tox
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 == 'dev-guide' %}
{%- if doc.type == 'api-ref' %}
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
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 %}
{% if doc.pdf_name -%}
@ -122,21 +122,6 @@ commands =
{% endif %}
{% 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]
ignore = D001
extensions = .rst, .yaml

View File

@ -1,12 +0,0 @@
---
- project:
merge-mode: squash-merge
default-branch: main
templates:
- helpcenter-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")
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")
doc_requirements_template = env.get_template("doc_requirements.txt.j2")
@ -260,16 +259,6 @@ def process_repositories(args, service):
out.write(doc_requirements_content)
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:
# Nothing to commit
logging.debug(
@ -355,11 +344,6 @@ def main():
action="store_true",
help="Whether to update service-based-view"
)
parser.add_argument(
"--update-zuul",
action="store_true",
help="Whether to update zuul.yaml"
)
parser.add_argument(
"--overwrite-index-sbv",
action="store_true",