infra/otc-metadata
16
0
Fork 13
Code Issues 1 Pull Requests 1 Packages Releases Wiki Activity

New template and options for Service-Based-View

Browse Source 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-committed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
This commit is contained in:
Gode, Sebastian 2023-04-20 13:10:18 +00:00 committed by zuul
parent 6c27e42e4b
commit b711305a4c
5 changed files with 95 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
otc_metadata/templates/conf.py.j2
View File

@ -18,7 +18,10 @@ import os
import sys
extensions = [
'otcdocstheme'
'otcdocstheme',
{%- if otc_sbv %}
'otc_sphinx_directives'
{%- endif %}
]
otcdocs_auto_name = False

3
otc_metadata/templates/doc_requirements.txt.j2
View File

@ -2,3 +2,6 @@ sphinx>=2.0.0,!=2.1.0 # BSD
otcdocstheme # Apache-2.0
# releasenotes
reno>=3.1.0 # Apache-2.0
otc-sphinx-directives>=0.1.0
git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata

7
otc_metadata/templates/index_sbv.rst.j2 Normal file
View File

@ -0,0 +1,7 @@
{{ sbv_title }}
.. directive_wrapper::
:class: container-sbv
.. service_card::
:service_type: {{ service_type }}

8
otc_metadata/templates/tox.ini.j2
View File

@ -29,7 +29,11 @@ allowlist_externals =
mkdir
cp
sh
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
{%- for doc in docs %}
{[testenv:{{ doc.type }}]commands}
{[testenv:json-{{ doc.type }}]commands}
@ -115,3 +119,7 @@ commands =
cp {{ loc }}/build/pdf/{{ doc.pdf_name }}.pdf doc/build/pdf/
{% endif %}
{% endfor %}
[doc8]
ignore = D001
extensions = .rst, .yaml

73
tools/generate_doc_confpy.py
View File

@ -50,6 +50,7 @@ def process_repositories(args, service):
)
conf_py_template = env.get_template("conf.py.j2")
tox_ini_template = env.get_template("tox.ini.j2")
index_sbv_template = env.get_template("index_sbv.rst.j2")
doc_requirements_template = env.get_template("doc_requirements.txt.j2")
for repo in service["repositories"]:
@ -155,7 +156,62 @@ def process_repositories(args, service):
out.write(conf_py_content)
repo_to.index.add([doc["rst_location"]])
if args.update_sbv:
"""Add or update service-based-view"""
copy_path = pathlib.Path(copy_to, 'doc', 'source')
context = dict(
repo_name=target_repo["repo"],
project=service["service_title"],
# pdf_name=doc["pdf_name"],
title=f"{service['service_title']} - Service Based View",
service_type=service["service_type"]
)
if not copy_path.exists():
logging.info("Path for sbv does not exist")
copy_path.mkdir(parents=True, exist_ok=True)
context["otc_sbv"] = True
if git_fqdn:
context["git_fqdn"] = git_fqdn
if target_repo.get("type") != "github":
context["git_type"] = target_repo["type"]
if args.target_environment == "internal":
context["html_options"] = dict(
disable_search=True,
site_name="Internal Documentation Portal",
logo_url="https://docs-int.otc-service.com",
)
sbv_title = (service["service_title"] + "\n"
+ ('=' * len(service["service_title"])))
context["sbv_title"] = sbv_title
conf_py_content = conf_py_template.render(**context)
index_sbv_content = index_sbv_template.render(**context)
with open(
pathlib.Path(copy_path, "conf.py"),
"w",
encoding="utf-8") as out:
out.write(conf_py_content)
repo_to.index.add(pathlib.Path(copy_path, "conf.py"))
if (not args.overwrite_index_sbv
and pathlib.Path(copy_path, "index.rst").exists()):
logging.info("File index.rst for sbv exists. Skipping")
else:
with open(
pathlib.Path(copy_path, "index.rst"),
"w",
encoding="utf-8") as out:
out.write(index_sbv_content)
repo_to.index.add(pathlib.Path(copy_path, "index.rst"))
placeholder_path = pathlib.Path(copy_path, "_static")
if not pathlib.Path(placeholder_path, "placeholder").exists():
placeholder_path.mkdir(parents=True, exist_ok=True)
open(pathlib.Path(placeholder_path, "placeholder"), 'a').close()
repo_to.index.add(pathlib.Path(placeholder_path, "placeholder"))
if args.update_tox:
"""Update tox.ini"""
context = dict(docs=[])
for doc in service_docs:
if doc["type"] == "dev":
@ -265,10 +321,27 @@ def main():
)
parser.add_argument("--token", metavar="token", help="API token")
parser.add_argument("--api-url", help="API base url of the Git hoster")
parser.add_argument(
"--update-sbv",
action="store_true",
help="Whether to update service-based-view"
)
parser.add_argument(
"--overwrite-index-sbv",
action="store_true",
help=("Whether to overwrite index.rst for service-based-view."
+ "\nCan only be used if --update-sbv is also specified")
)
args = parser.parse_args()
logging.basicConfig(level=logging.DEBUG)
services = []
if args.overwrite_index_sbv and not args.update_sbv:
logging.error(
"Cannot overwrite index.rst for service-based-view"
+ " without updating service-based-view"
)
exit(1)
if args.service_type:
services = [data.service_dict.get(args.service_type)]
else: