Compare commits
11 Commits
various_fi
...
setuptools
Author | SHA1 | Date | |
---|---|---|---|
be56be7b24 | |||
bff9eff2bd | |||
d5e7269ae9 | |||
1541a02210 | |||
96ffbc1403 | |||
ca8c5fb34c | |||
a6a001cdba | |||
7b319ca858 | |||
9bb3ef92a5 | |||
898c1aafc2 | |||
d8ed8a0ba4 |
@ -1,3 +1,3 @@
|
||||
---
|
||||
name: database
|
||||
title: Database
|
||||
title: Databases
|
||||
|
@ -46,6 +46,7 @@ otcdocs_service_category = '{{ service_category }}'
|
||||
otcdocs_service_title = '{{ service_title }}'
|
||||
otcdocs_service_type = '{{ service_type }}'
|
||||
otcdocs_search_environment = 'hc_swiss'
|
||||
otcdocs_search_index = 'search_index_swiss'
|
||||
otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/"
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
|
@ -1,7 +1,15 @@
|
||||
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
|
||||
{% else %}
|
||||
otcdocstheme # Apache-2.0
|
||||
{% endif %}
|
||||
# releasenotes
|
||||
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-swiss.git#egg=otc_metadata
|
||||
setuptools
|
||||
|
@ -34,8 +34,9 @@ allowlist_externals =
|
||||
rm
|
||||
sphinx-build
|
||||
commands =
|
||||
rm -rf doc/build/html doc/build/doctrees
|
||||
sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html
|
||||
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
|
||||
{%- for doc in docs %}
|
||||
{[testenv:{{ doc.type }}]commands}
|
||||
{[testenv:json-{{ doc.type }}]commands}
|
||||
@ -66,16 +67,14 @@ allowlist_externals =
|
||||
cp
|
||||
mkdir
|
||||
commands =
|
||||
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' %}
|
||||
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' %}
|
||||
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)
|
||||
@ -90,15 +89,12 @@ 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 == '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' %}
|
||||
{%- if 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 -%}
|
||||
|
@ -148,8 +148,30 @@ def process_repositories(args, service):
|
||||
context["html_options"] = dict(
|
||||
disable_search=True,
|
||||
site_name="Internal Documentation Portal",
|
||||
logo_url="https://docs-int.otc-service.com",
|
||||
logo_url="https://docs-int.sc.otc.t-systems.com",
|
||||
)
|
||||
else:
|
||||
context["html_options"] = dict(
|
||||
site_name="Swiss Open Telekom Cloud Docs",
|
||||
logo_url="https://docs-beta.sc.otc.t-systems.com",
|
||||
)
|
||||
context["doc_environment"] = args.target_environment
|
||||
if doc['link']:
|
||||
context["doc_link"] = doc['link']
|
||||
else:
|
||||
context["doc_link"] = (
|
||||
'/'
|
||||
+ service['service_uri']
|
||||
+ '/'
|
||||
+ doc['type']
|
||||
+ '/'
|
||||
)
|
||||
context["doc_title"] = doc['title']
|
||||
context["doc_type"] = doc['type']
|
||||
context["service_category"] = service['service_category']
|
||||
context["service_title"] = service['service_title']
|
||||
context["service_type"] = service['service_type']
|
||||
|
||||
conf_py_content = conf_py_template.render(**context)
|
||||
with open(conf_py_path, "w", encoding="utf-8", newline="") as out:
|
||||
logging.debug(f"Generating {conf_py_path} from template...")
|
||||
@ -167,6 +189,8 @@ def process_repositories(args, service):
|
||||
title=f"{service['service_title']} - Service Based View",
|
||||
service_type=service["service_type"]
|
||||
)
|
||||
context["service_category"] = service['service_category']
|
||||
context["service_title"] = service['service_title']
|
||||
if not copy_path.exists():
|
||||
logging.info("Path for sbv does not exist")
|
||||
copy_path.mkdir(parents=True, exist_ok=True)
|
||||
@ -179,7 +203,12 @@ def process_repositories(args, service):
|
||||
context["html_options"] = dict(
|
||||
disable_search=True,
|
||||
site_name="Internal Documentation Portal",
|
||||
logo_url="https://docs-int.otc-service.com",
|
||||
logo_url="https://docs-int.sc.otc.t-systems.com",
|
||||
)
|
||||
else:
|
||||
context["html_options"] = dict(
|
||||
site_name="Swiss Open Telekom Cloud Docs",
|
||||
logo_url="https://docs-beta.sc.otc.t-systems.com",
|
||||
)
|
||||
sbv_title = (service["service_title"] + "\n"
|
||||
+ ('=' * len(service["service_title"])))
|
||||
@ -218,6 +247,8 @@ def process_repositories(args, service):
|
||||
doc["type"] = "dev-guide"
|
||||
context["docs"].append(doc)
|
||||
|
||||
context["target_environment"] = args.target_environment
|
||||
|
||||
tox_ini_content = tox_ini_template.render(**context)
|
||||
tox_ini_path = pathlib.Path(copy_to, "tox.ini")
|
||||
doc_requirements_content = doc_requirements_template.render(**context)
|
||||
@ -248,7 +279,7 @@ def process_repositories(args, service):
|
||||
args.commit_description
|
||||
)
|
||||
push_args = ["--set-upstream", "origin", branch_name]
|
||||
if args.branch_force:
|
||||
if args.force_push:
|
||||
push_args.append("--force")
|
||||
repo_to.git.push(*push_args)
|
||||
if "github" in url_to:
|
||||
@ -294,6 +325,7 @@ def main():
|
||||
parser.add_argument(
|
||||
"--target-environment",
|
||||
required=True,
|
||||
choices=["internal", "public"],
|
||||
help="Environment to be used as a source",
|
||||
)
|
||||
parser.add_argument("--service-type", help="Service to update")
|
||||
@ -328,6 +360,11 @@ def main():
|
||||
help=("Whether to overwrite index.rst for service-based-view."
|
||||
+ "\nCan only be used if --update-sbv is also specified")
|
||||
)
|
||||
parser.add_argument(
|
||||
"--force-push",
|
||||
action="store_true",
|
||||
help="Whether to force push the commit"
|
||||
)
|
||||
parser.add_argument(
|
||||
"--commit-description",
|
||||
default=(
|
||||
|
Reference in New Issue
Block a user