Compare commits

...

1 Commits
main ... x2

Author SHA1 Message Date
106fff6976 Update tox.ini && conf.py file
Performed-by: gitea/infra/otc-metadata/tools/generate_doc_confpy.py
2022-11-08 21:32:59 +01:00
3 changed files with 48 additions and 32 deletions

View File

@ -78,7 +78,7 @@ html_theme = 'otcdocs'
# further. For a list of options available for each theme, see the
# documentation.
html_theme_options = {
"disable_search": "True",
"disable_search": True,
"site_name": "Internal Documentation Portal",
"logo_url": "https://docs-int.otc-service.com",
}

68
tox.ini
View File

@ -1,6 +1,6 @@
[tox]
minversion = 3.1
envlist = py36,py37,pep8
envlist = py39,pep8
skipsdist = True
ignore_basepython_conflict = True
@ -22,51 +22,67 @@ deps =
commands = {posargs}
[testenv:docs]
deps =
-c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
-r{toxinidir}/doc/requirements.txt
commands =
sphinx-build -W --keep-going -b html doc/source/ doc/build/html
{[testenv:api-ref]commands}
{[testenv:umn]commands}
[testenv:docs-pdf]
whitelist_externals =
mkdir
commands =
mkdir -p doc/build/pdf
{[testenv:api-ref-pdf-docs]commands}
{[testenv:umn-pdf-docs]commands}
[testenv:api-ref]
# This environment is called from CI scripts to test and publish
# the API Ref to docs.otc-service.com
deps =
-r{toxinidir}/requirements.txt
whitelist_externals = rm
whitelist_externals =
cp
mkdir
commands =
rm -rf api-ref/build
sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html
sphinx-build -W --keep-going -b html api-ref/source doc/build/html/api-ref
mkdir -p api-ref/build/html
cp -av doc/build/html/api-ref api-ref/build/html
[testenv:api-ref-pdf-docs]
deps = {[testenv:api-ref]deps}
envdir = {toxworkdir}/api-ref
whitelist_externals =
rm
mkdir
make
bash
cp
commands =
rm -rf api-ref/build/pdf
sphinx-build -a -E -W -b latex api-ref/source api-ref/build/pdf
sphinx-build -W --keep-going -b latex api-ref/source api-ref/build/pdf/
bash -c "for f in api-ref/build/pdf/*.gif; do convert $f $\{f/%gif/png\}; done || true"
bash -c "for f in api-ref/build/pdf/*.tex; do sed -iorig 's/\.gif//g' $f; done"
make -C api-ref/build/pdf
mkdir -p doc/build/pdf
cp api-ref/build/pdf/wafd-api-ref.pdf doc/build/pdf/
[testenv:umn]
# This environment is called from CI scripts to test and publish
# the UMN to docs.otc-service.com
deps =
-r{toxinidir}/requirements.txt
whitelist_externals = rm
whitelist_externals =
cp
mkdir
commands =
rm -rf umn/build
sphinx-build -W -b html -d umn/build/doctrees umn/source umn/build/html
sphinx-build -W --keep-going -b html umn/source doc/build/html/umn
mkdir -p umn/build/html
cp -av doc/build/html/umn umn/build/html
[testenv:umn-pdf-docs]
deps = {[testenv:umn]deps}
envdir = {toxworkdir}/umn
whitelist_externals =
rm
mkdir
make
sh
bash
cp
commands =
rm -rf umn/build/pdf
sphinx-build -a -E -W -b latex umn/source umn/build/pdf
sphinx-build -W --keep-going -b latex umn/source umn/build/pdf/
bash -c "for f in umn/build/pdf/*.gif; do convert $f $\{f/%gif/png\}; done || true"
bash -c "for f in umn/build/pdf/*.tex; do sed -iorig 's/\.gif//g' $f; done"
make -C umn/build/pdf
mkdir -p doc/build/pdf
cp umn/build/pdf/wafd-umn.pdf doc/build/pdf/

View File

@ -78,7 +78,7 @@ html_theme = 'otcdocs'
# further. For a list of options available for each theme, see the
# documentation.
html_theme_options = {
"disable_search": "True",
"disable_search": True,
"site_name": "Internal Documentation Portal",
"logo_url": "https://docs-int.otc-service.com",
}