add PLAS title

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>

otc_metadata/templates/conf.py.j2

@@ -104,6 +104,9 @@ html_title = "{{ title }}"
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
+# Do not include sources into the rendered results
+html_copy_source = False
+
 # -- Options for PDF output --------------------------------------------------
 latex_documents = [
 {%- if pdf_name is defined %}

otc_metadata/templates/tox.ini.j2

@@ -21,8 +21,14 @@ deps =
   -r{toxinidir}/requirements.txt
 commands = {posargs}
 
+# This env is invoked in the periodic pipeline and is therefore responsible to
+# build all relevant docs at once.
 [testenv:docs]
 deps = -r{toxinidir}/doc/requirements.txt
+allowlist_externals =
+  mkdir
+  cp
+  sh
 commands =
 {%- for doc in docs %}
   {[testenv:{{ doc.type }}]commands}
@@ -32,7 +38,11 @@ commands =
 [testenv:docs-pdf]
 deps = -r{toxinidir}/doc/requirements.txt
 allowlist_externals =
+  rm
   mkdir
+  make
+  bash
+  cp
 commands =
   mkdir -p doc/build/pdf
 {%- for doc in docs %}
@@ -68,11 +78,12 @@ deps = -r{toxinidir}/doc/requirements.txt
 allowlist_externals =
   cp
   mkdir
-  find
+  sh
 commands =
   sphinx-build -W --keep-going -b json {{ loc }}/source doc/build/json/{{ doc.type }}
-  # Drop data useless for the search
+  # Drop data useless for the search - wrap it also with sh/xargs due to bugs
-  find doc/build/json -type d -and ( -name '_images' -or -name '_static' -or -name '_sources' ) -exec rm {:} ;
+  # 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

tools-requirements.txt

@@ -1,2 +1,5 @@
 GitPython
-ruamel
+ruamel.yaml
+requests
+jinja2
+dirsync

tools/generate_doc_confpy.py

@@ -201,7 +201,7 @@ def process_repositories(args, service):
     repo_to.git.push(*push_args)
     if "github" in url_to:
         subprocess.run(
-            args=["gh", "pr", "create", "-f"], cwd=copy_to, check=True
+            args=["gh", "pr", "create", "-f"], cwd=copy_to, check=False
         )
     elif "gitea" in url_to and args.token:
         open_pr(

tools/generate_doc_gitcontrol_repos.py

@@ -46,7 +46,7 @@ def process_services(args, services):
         has_wiki=False,
         default_delete_branch_after_merge=True,
         allow_merge_commit=False,
-        allow_squash_merge=False,
+        allow_squash_merge=True,
         allow_rebase_merge=False,
         default_merge_style="squash",
         branch_protections=[],

tools/sync_doc_repo.py

@@ -18,9 +18,9 @@ import argparse
 import logging
 import os
 import pathlib
-import shutil
 import subprocess
 import warnings
+from dirsync import sync
 
 from git import Repo
 from git import SymbolicReference
@@ -111,13 +111,21 @@ def process_repositories(args, service):
         new_branch.set_tracking_branch(remote_ref)
         new_branch.checkout()
 
-        shutil.copytree(
+        source_path = pathlib.Path(copy_from, doc["rst_location"])
-            pathlib.Path(copy_from, doc["rst_location"]),
+        target_path = pathlib.Path(copy_to, doc["rst_location"])
-            pathlib.Path(copy_to, doc["rst_location"]),
+        sync(
-            ignore=lambda a, b: ["conf.py"],
+            source_path,
-            dirs_exist_ok=True,
+            target_path,
+            'sync',
+            purge=True,
+            create=True,
+            content=True,
+            ignore=['conf.py']
         )
         repo_to.index.add([doc["rst_location"]])
+
+        for obj in repo_to.index.diff(None).iter_change_type('D'):
+            repo_to.index.remove([obj.b_path])
         if len(repo_to.index.diff("HEAD")) == 0:
             # Nothing to commit
             logging.debug("No changes.")