Compare commits

..

2 Commits

Author SHA1 Message Date
135c8a9bc8 fix pep8
All checks were successful
gl/check check status: success (135c8a9bc871391ad718266577c75c2ddc9af25c)
gl/gate gate status: success (135c8a9bc871391ad718266577c75c2ddc9af25c)
2023-11-15 13:43:51 +00:00
dd5e48a0cd Differentiate between public and internal otcdocstheme
Some checks failed
gl/check check status: failure (dd5e48a0cdcb83844607b27bc6c10836a2ab4466)
2023-11-15 13:38:02 +00:00
3 changed files with 26 additions and 14 deletions

View File

@ -1,8 +1,13 @@
sphinx>=2.0.0,!=2.1.0 # BSD 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 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
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

View File

@ -34,9 +34,8 @@ allowlist_externals =
rm rm
sphinx-build sphinx-build
commands = commands =
rm -rf doc/build/html doc/build/html_temp doc/build/doctrees rm -rf doc/build/html doc/build/doctrees
sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html_temp sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html
sphinx-minify --input-directory doc/build/html_temp/ --output-directory doc/build/html
{%- for doc in docs %} {%- for doc in docs %}
{[testenv:{{ doc.type }}]commands} {[testenv:{{ doc.type }}]commands}
{[testenv:json-{{ doc.type }}]commands} {[testenv:json-{{ doc.type }}]commands}
@ -67,14 +66,16 @@ allowlist_externals =
cp cp
mkdir mkdir
commands = commands =
sphinx-build -W --keep-going -b html {{ loc }}/source doc/build/html_temp/{{ doc.type }} sphinx-build -W --keep-going -b html {{ loc }}/source doc/build/html/{{ doc.type }}
sphinx-minify --input-directory doc/build/html_temp/{{ doc.type }} --output-directory doc/build/html/{{ doc.type }} {%- if doc.type == 'api-ref' %}
{%- if doc.type == 'dev-guide' %} 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 mkdir -p dev_guide/build/html
cp -av doc/build/html/dev-guide 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 %} {%- endif %}
# Json version (for search) # Json version (for search)
@ -89,12 +90,15 @@ commands =
# Drop data useless for the search - wrap it also with sh/xargs due to bugs # Drop data useless for the search - wrap it also with sh/xargs due to bugs
# in tox # in tox
sh -c "find doc/build/json -type d -and '(' -name '_images' -or -name '_static' -or -name '_sources' ')' -print0 | xargs -0 rm -rf" 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 mkdir -p dev_guide/build/json
cp -av doc/build/json/dev-guide 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 %} {%- endif %}
{% if doc.pdf_name -%} {% if doc.pdf_name -%}

View File

@ -247,6 +247,8 @@ 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)
@ -323,6 +325,7 @@ 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")