Compare commits
14 Commits
fix_genera
...
increase-o
Author | SHA1 | Date | |
---|---|---|---|
e32c8e2df4 | |||
c6be426256 | |||
78c1a0b0e2 | |||
582216f26b | |||
1434915c01 | |||
bff9eff2bd | |||
d5e7269ae9 | |||
1541a02210 | |||
96ffbc1403 | |||
ca8c5fb34c | |||
a6a001cdba | |||
7b319ca858 | |||
9bb3ef92a5 | |||
898c1aafc2 |
3
.gitignore
vendored
3
.gitignore
vendored
@ -59,3 +59,6 @@ ChangeLog
|
||||
|
||||
# Files created by releasenotes build
|
||||
releasenotes/build
|
||||
|
||||
bindep.txt
|
||||
packages.txt
|
@ -1,3 +1,3 @@
|
||||
---
|
||||
name: database
|
||||
title: Database
|
||||
title: Databases
|
||||
|
@ -46,6 +46,7 @@ otcdocs_service_category = '{{ service_category }}'
|
||||
otcdocs_service_title = '{{ service_title }}'
|
||||
otcdocs_service_type = '{{ service_type }}'
|
||||
otcdocs_search_environment = 'hc_swiss'
|
||||
otcdocs_search_index = 'search_index_swiss'
|
||||
otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/"
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
|
@ -1,7 +1,15 @@
|
||||
sphinx>=2.0.0,!=2.1.0 # BSD
|
||||
{% if target_environment == 'public' %}
|
||||
otcdocstheme<2.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-swiss.git#egg=otc_metadata
|
||||
setuptools
|
||||
|
@ -34,23 +34,28 @@ 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 = {[testenv:docs]deps}
|
||||
deps =
|
||||
{[testenv:docs]deps}
|
||||
{[testenv:bindeps]deps}
|
||||
allowlist_externals =
|
||||
rm
|
||||
mkdir
|
||||
wget
|
||||
make
|
||||
bash
|
||||
cp
|
||||
commands =
|
||||
mkdir -p doc/build/pdf
|
||||
{[testenv:bindeps]commands}
|
||||
{%- for doc in docs %}
|
||||
{%- if doc.pdf_name %}
|
||||
{[testenv:{{ doc.type }}-pdf-docs]commands}
|
||||
@ -66,16 +71,14 @@ 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)
|
||||
@ -90,15 +93,12 @@ 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 -%}
|
||||
@ -122,6 +122,21 @@ commands =
|
||||
{% endif %}
|
||||
{% 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]
|
||||
ignore = D001
|
||||
extensions = .rst, .yaml
|
12
otc_metadata/templates/zuul.yaml.j2
Normal file
12
otc_metadata/templates/zuul.yaml.j2
Normal file
@ -0,0 +1,12 @@
|
||||
---
|
||||
- project:
|
||||
merge-mode: squash-merge
|
||||
default-branch: main
|
||||
templates:
|
||||
- helpcenter-swiss-base-jobs
|
||||
check:
|
||||
jobs:
|
||||
- noop
|
||||
gate:
|
||||
jobs:
|
||||
- noop
|
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user