From c4a364ecac0098df25925a3dda6f2dba27379fec Mon Sep 17 00:00:00 2001 From: "Goncharov, Artem" Date: Tue, 8 Nov 2022 21:12:11 +0000 Subject: [PATCH] Update Docs configuration Reviewed-by: gtema Co-authored-by: Goncharov, Artem Co-committed-by: Goncharov, Artem --- api-ref/source/conf.py | 2 +- tox.ini | 78 +++++++++++++++++++++++++----------------- umn/source/conf.py | 2 +- 3 files changed, 48 insertions(+), 34 deletions(-) diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index c443087..344dbf0 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -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", } diff --git a/tox.ini b/tox.ini index 3207bd4..f9ccb41 100644 --- a/tox.ini +++ b/tox.ini @@ -1,6 +1,6 @@ [tox] minversion = 3.1 -envlist = py36,py37,pep8 +envlist = py39,pep8 skipsdist = True ignore_basepython_conflict = True @@ -8,67 +8,81 @@ ignore_basepython_conflict = True usedevelop = True install_command = pip install {opts} {packages} deps = - -r{toxinidir}/requirements.txt + -r{toxinidir}/requirements.txt commands = stestr run {posargs} - stestr slowest + stestr slowest [testenv:pep8] commands = - doc8 doc/source README.rst + doc8 doc/source README.rst [testenv:venv] deps = - -r{toxinidir}/requirements.txt + -r{toxinidir}/requirements.txt 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/swr-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 - sh -c "for f in umn/build/pdf/*.gif; do gif2png -dprsO $f; done || true" - sh -c "for f in umn/build/pdf/*.tex; do sed -iorig 's/\.gif//g' $f; done" + 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/swr-umn.pdf doc/build/pdf/ + diff --git a/umn/source/conf.py b/umn/source/conf.py index a80653a..6d80bb9 100644 --- a/umn/source/conf.py +++ b/umn/source/conf.py @@ -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", }