Mega main
All checks were successful
gl/check check status: success (b1bf66f02730304b902c8c3de5bd423548f2b2a2)
All checks were successful
gl/check check status: success (b1bf66f02730304b902c8c3de5bd423548f2b2a2)
This commit is contained in:
@ -46,6 +46,7 @@ otcdocs_service_category = "{{ service_category }}"
|
||||
otcdocs_service_title = "{{ service_title }}"
|
||||
otcdocs_service_type = "{{ service_type }}"
|
||||
otcdocs_search_environment = "hc_de"
|
||||
otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/"
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
|
@ -1,7 +1,14 @@
|
||||
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
|
||||
{% else %}
|
||||
otcdocstheme # Apache-2.0
|
||||
{% endif %}
|
||||
# releasenotes
|
||||
reno>=3.1.0 # Apache-2.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
|
@ -24,7 +24,9 @@ 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
|
||||
deps =
|
||||
-r{toxinidir}/doc/requirements.txt
|
||||
-c https://raw.githubusercontent.com/opentelekomcloud-docs/docs-constraints/main/constraints.txt
|
||||
allowlist_externals =
|
||||
mkdir
|
||||
cp
|
||||
@ -32,15 +34,16 @@ allowlist_externals =
|
||||
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
|
||||
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_temp
|
||||
sphinx-minify --input-directory doc/build/html_temp/ --output-directory doc/build/html
|
||||
{%- for doc in docs %}
|
||||
{[testenv:{{ doc.type }}]commands}
|
||||
{[testenv:json-{{ doc.type }}]commands}
|
||||
{%- endfor %}
|
||||
|
||||
[testenv:docs-pdf]
|
||||
deps = -r{toxinidir}/doc/requirements.txt
|
||||
deps = {[testenv:docs]deps}
|
||||
allowlist_externals =
|
||||
rm
|
||||
mkdir
|
||||
@ -59,26 +62,24 @@ commands =
|
||||
{% set loc = doc.rst_location | replace('/source', '') %}
|
||||
# HTML version
|
||||
[testenv:{{ doc.type }}]
|
||||
deps = -r{toxinidir}/doc/requirements.txt
|
||||
deps = {[testenv:docs]deps}
|
||||
allowlist_externals =
|
||||
cp
|
||||
mkdir
|
||||
commands =
|
||||
sphinx-build -W --keep-going -b html {{ loc }}/source doc/build/html/{{ doc.type }}
|
||||
{%- if doc.type == 'api-ref' %}
|
||||
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' %}
|
||||
sphinx-build -W --keep-going -b html {{ loc }}/source doc/build/html_temp/{{ doc.type }}
|
||||
sphinx-minify --input-directory doc/build/html_temp/{{ doc.type }} --output-directory doc/build/html/{{ doc.type }}
|
||||
{%- if doc.type == 'dev-guide' %}
|
||||
mkdir -p 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 %}
|
||||
|
||||
# Json version (for search)
|
||||
[testenv:json-{{ doc.type }}]
|
||||
deps = -r{toxinidir}/doc/requirements.txt
|
||||
deps = {[testenv:docs]deps}
|
||||
allowlist_externals =
|
||||
cp
|
||||
mkdir
|
||||
@ -88,21 +89,18 @@ commands =
|
||||
# Drop data useless for the search - wrap it also with sh/xargs due to bugs
|
||||
# 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
|
||||
{%- elif doc.type == 'umn' %}
|
||||
mkdir -p umn/build/json
|
||||
cp -av doc/build/json/umn umn/build/json
|
||||
{%- elif doc.type == 'dev-guide' %}
|
||||
{%- if doc.type == 'dev-guide' %}
|
||||
mkdir -p 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 %}
|
||||
|
||||
{% if doc.pdf_name -%}
|
||||
# PDF version
|
||||
[testenv:{{ doc.type }}-pdf-docs]
|
||||
deps = -r{toxinidir}/doc/requirements.txt
|
||||
deps = {[testenv:docs]deps}
|
||||
allowlist_externals =
|
||||
rm
|
||||
mkdir
|
||||
|
Reference in New Issue
Block a user