From 179b0d6370f5fca577b92118ceb00d46498996a1 Mon Sep 17 00:00:00 2001 From: "Goncharov, Artem" Date: Mon, 2 Jan 2023 21:16:32 +0000 Subject: [PATCH] Update Docs configuration Reviewed-by: gtema Co-authored-by: Goncharov, Artem Co-committed-by: Goncharov, Artem --- tox.ini | 50 +++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 45 insertions(+), 5 deletions(-) diff --git a/tox.ini b/tox.ini index 0b45907..48682bd 100644 --- a/tox.ini +++ b/tox.ini @@ -22,12 +22,16 @@ deps = commands = {posargs} [testenv:docs] +deps = -r{toxinidir}/doc/requirements.txt commands = {[testenv:api-ref]commands} + {[testenv:json-api-ref]commands} {[testenv:umn]commands} + {[testenv:json-umn]commands} [testenv:docs-pdf] -whitelist_externals = +deps = -r{toxinidir}/doc/requirements.txt +allowlist_externals = mkdir commands = mkdir -p doc/build/pdf @@ -35,8 +39,10 @@ commands = {[testenv:umn-pdf-docs]commands} +# HTML version [testenv:api-ref] -whitelist_externals = +deps = -r{toxinidir}/doc/requirements.txt +allowlist_externals = cp mkdir commands = @@ -44,8 +50,24 @@ commands = mkdir -p api-ref/build/html cp -av doc/build/html/api-ref api-ref/build/html +# Json version (for search) +[testenv:json-api-ref] +deps = -r{toxinidir}/doc/requirements.txt +allowlist_externals = + cp + mkdir + find +commands = + sphinx-build -W --keep-going -b json api-ref/source doc/build/json/api-ref + # Drop data useless for the search + find doc/build/json -type d -and ( -name '_images' -or -name '_static' -or -name '_sources' ) -exec rm {:} ; + mkdir -p api-ref/build/json + cp -av doc/build/json/api-ref api-ref/build/json + +# PDF version [testenv:api-ref-pdf-docs] -whitelist_externals = +deps = -r{toxinidir}/doc/requirements.txt +allowlist_externals = rm mkdir make @@ -61,8 +83,10 @@ commands = cp api-ref/build/pdf/gaussdb_mysql-api-ref.pdf doc/build/pdf/ +# HTML version [testenv:umn] -whitelist_externals = +deps = -r{toxinidir}/doc/requirements.txt +allowlist_externals = cp mkdir commands = @@ -70,8 +94,24 @@ commands = mkdir -p umn/build/html cp -av doc/build/html/umn umn/build/html +# Json version (for search) +[testenv:json-umn] +deps = -r{toxinidir}/doc/requirements.txt +allowlist_externals = + cp + mkdir + find +commands = + sphinx-build -W --keep-going -b json umn/source doc/build/json/umn + # Drop data useless for the search + find doc/build/json -type d -and ( -name '_images' -or -name '_static' -or -name '_sources' ) -exec rm {:} ; + mkdir -p umn/build/json + cp -av doc/build/json/umn umn/build/json + +# PDF version [testenv:umn-pdf-docs] -whitelist_externals = +deps = -r{toxinidir}/doc/requirements.txt +allowlist_externals = rm mkdir make