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

Added sphinx-minify to tox

Browse Source 
Reviewed-by: tischrei <tino.schreiber@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-11-01 13:29:42 +00:00
committed by zuul
parent e3be33c237
commit 7bab061bd2
2 changed files with 10 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -10,4 +10,5 @@ otcdocstheme # Apache-2.0
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.git#egg=otc_metadata git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata

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

@ -34,8 +34,9 @@ allowlist_externals =
rm rm
sphinx-build sphinx-build
commands = commands =
rm -rf doc/build/html doc/build/doctrees 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 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 %} {%- for doc in docs %}
{[testenv:{{ doc.type }}]commands} {[testenv:{{ doc.type }}]commands}
{[testenv:json-{{ doc.type }}]commands} {[testenv:json-{{ doc.type }}]commands}
@ -66,17 +67,10 @@ allowlist_externals =
cp cp
mkdir mkdir
commands = commands =
sphinx-build -W --keep-going -b html {{ loc }}/source doc/build/html/{{ doc.type }} sphinx-build -W --keep-going -b html {{ loc }}/source doc/build/html_temp/{{ doc.type }}
{%- if doc.type == 'api-ref' %} sphinx-minify --input-directory doc/build/html_temp/{{ doc.type }} --output-directory doc/build/html/{{ doc.type }}
mkdir -p api-ref/build/html mkdir -p {{ doc.type }}/build/html
cp -av doc/build/html/api-ref api-ref/build/html cp -av doc/build/html/{{ doc.type }} {{ doc.type }}/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
{%- endif %}
# Json version (for search) # Json version (for search)
[testenv:json-{{ doc.type }}] [testenv:json-{{ doc.type }}]
@ -90,16 +84,8 @@ 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 == 'api-ref' %} mkdir -p {{ doc.type }}/build/json
mkdir -p api-ref/build/json cp -av doc/build/json/{{ doc.type }} {{ doc.type }}/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
{%- endif %}
{% if doc.pdf_name -%} {% if doc.pdf_name -%}
# PDF version # PDF version