|
|
@ -34,28 +34,23 @@ 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}
|
|
|
|
{%- endfor %}
|
|
|
|
{%- endfor %}
|
|
|
|
|
|
|
|
|
|
|
|
[testenv:docs-pdf]
|
|
|
|
[testenv:docs-pdf]
|
|
|
|
deps =
|
|
|
|
deps = {[testenv:docs]deps}
|
|
|
|
{[testenv:docs]deps}
|
|
|
|
|
|
|
|
{[testenv:bindeps]deps}
|
|
|
|
|
|
|
|
allowlist_externals =
|
|
|
|
allowlist_externals =
|
|
|
|
rm
|
|
|
|
rm
|
|
|
|
mkdir
|
|
|
|
mkdir
|
|
|
|
wget
|
|
|
|
|
|
|
|
make
|
|
|
|
make
|
|
|
|
bash
|
|
|
|
bash
|
|
|
|
cp
|
|
|
|
cp
|
|
|
|
commands =
|
|
|
|
commands =
|
|
|
|
mkdir -p doc/build/pdf
|
|
|
|
mkdir -p doc/build/pdf
|
|
|
|
{[testenv:bindeps]commands}
|
|
|
|
|
|
|
|
{%- for doc in docs %}
|
|
|
|
{%- for doc in docs %}
|
|
|
|
{%- if doc.pdf_name %}
|
|
|
|
{%- if doc.pdf_name %}
|
|
|
|
{[testenv:{{ doc.type }}-pdf-docs]commands}
|
|
|
|
{[testenv:{{ doc.type }}-pdf-docs]commands}
|
|
|
@ -71,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)
|
|
|
@ -93,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 -%}
|
|
|
@ -122,21 +122,6 @@ commands =
|
|
|
|
{% endif %}
|
|
|
|
{% endif %}
|
|
|
|
{% endfor %}
|
|
|
|
{% endfor %}
|
|
|
|
|
|
|
|
|
|
|
|
[testenv:bindeps]
|
|
|
|
|
|
|
|
deps =
|
|
|
|
|
|
|
|
bindep
|
|
|
|
|
|
|
|
allowlist_externals =
|
|
|
|
|
|
|
|
wget
|
|
|
|
|
|
|
|
rm
|
|
|
|
|
|
|
|
bash
|
|
|
|
|
|
|
|
commands =
|
|
|
|
|
|
|
|
rm -rf {toxinidir}/bindep.txt
|
|
|
|
|
|
|
|
rm -rf {toxinidir}/packages.txt
|
|
|
|
|
|
|
|
wget -O {toxinidir}/bindep.txt https://raw.githubusercontent.com/opentelekomcloud/otcdocstheme/main/bindep.txt
|
|
|
|
|
|
|
|
bash -c "bindep test -b -f {toxinidir}/bindep.txt > {toxinidir}/packages.txt || true"
|
|
|
|
|
|
|
|
bash -c 'if [ -s {toxinidir}/packages.txt ]; then if command -v apt &>/dev/null; then apt update && xargs apt install --no-install-recommends -y < {toxinidir}/packages.txt; fi; fi'
|
|
|
|
|
|
|
|
bash -c 'if [ -s {toxinidir}/packages.txt ]; then if command -v dnf &>/dev/null; then dnf install -y $(cat {toxinidir}/packages.txt); fi; fi'
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[doc8]
|
|
|
|
[doc8]
|
|
|
|
ignore = D001
|
|
|
|
ignore = D001
|
|
|
|
extensions = .rst, .yaml
|
|
|
|
extensions = .rst, .yaml
|