Update Docs configuration

Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Goncharov, Artem <artem.goncharov@t-systems.com>
Co-committed-by: Goncharov, Artem <artem.goncharov@t-systems.com>
This commit is contained in:
Goncharov, Artem 2022-11-08 20:11:04 +00:00 committed by zuul
parent 5702f8c2b5
commit 5ca6e9bb74
3 changed files with 40 additions and 47 deletions

View File

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

68
tox.ini
View File

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

View File

@ -78,7 +78,7 @@ html_theme = 'otcdocs'
# further. For a list of options available for each theme, see the # further. For a list of options available for each theme, see the
# documentation. # documentation.
html_theme_options = { html_theme_options = {
"disable_search": "True", "disable_search": True,
"site_name": "Internal Documentation Portal", "site_name": "Internal Documentation Portal",
"logo_url": "https://docs-int.otc-service.com", "logo_url": "https://docs-int.otc-service.com",
} }
@ -95,9 +95,4 @@ html_title = "Cloud Container Service - User Guide"
html_static_path = ['_static'] html_static_path = ['_static']
# -- Options for PDF output -------------------------------------------------- # -- Options for PDF output --------------------------------------------------
latex_documents = [ latex_documents = []
('index',
'cce-umn.tex',
u'Cloud Container Service - User Guide',
u'OpenTelekomCloud', 'manual'),
]