Compare commits

...

1 Commits

Author SHA1 Message Date
0c9c787874 Update tox.ini && conf.py file
Performed-by: gitea/infra/otc-metadata/tools/generate_doc_confpy.py
2023-01-06 18:49:02 +01:00
3 changed files with 17 additions and 7 deletions

View File

@ -94,6 +94,9 @@ html_title = "Distributed Cache Service - API Reference"
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static'] html_static_path = ['_static']
# Do not include sources into the rendered results
html_copy_source = False
# -- Options for PDF output -------------------------------------------------- # -- Options for PDF output --------------------------------------------------
latex_documents = [ latex_documents = [
('index', ('index',

18
tox.ini
View File

@ -21,12 +21,14 @@ deps =
-r{toxinidir}/requirements.txt -r{toxinidir}/requirements.txt
commands = {posargs} commands = {posargs}
# This env is invoked in the periodic pipeline and is therefore responsible to
# build all relevant docs at once.
[testenv:docs] [testenv:docs]
deps = -r{toxinidir}/doc/requirements.txt deps = -r{toxinidir}/doc/requirements.txt
allowlist_externals = allowlist_externals =
mkdir mkdir
cp cp
find sh
commands = commands =
{[testenv:api-ref]commands} {[testenv:api-ref]commands}
{[testenv:json-api-ref]commands} {[testenv:json-api-ref]commands}
@ -64,11 +66,12 @@ deps = -r{toxinidir}/doc/requirements.txt
allowlist_externals = allowlist_externals =
cp cp
mkdir mkdir
find sh
commands = commands =
sphinx-build -W --keep-going -b json api-ref/source doc/build/json/api-ref sphinx-build -W --keep-going -b json api-ref/source doc/build/json/api-ref
# Drop data useless for the search # Drop data useless for the search - wrap it also with sh/xargs due to bugs
find doc/build/json -type d -and ( -name '_images' -or -name '_static' -or -name '_sources' ) -exec rm {:} ; # in tox
sh -c "find doc/build/json -type d -and '(' -name '_images' -or -name '_static' -or -name '_sources' ')' -print0 | xargs -0 rm -rf"
mkdir -p api-ref/build/json mkdir -p api-ref/build/json
cp -av doc/build/json/api-ref api-ref/build/json cp -av doc/build/json/api-ref api-ref/build/json
@ -108,11 +111,12 @@ deps = -r{toxinidir}/doc/requirements.txt
allowlist_externals = allowlist_externals =
cp cp
mkdir mkdir
find sh
commands = commands =
sphinx-build -W --keep-going -b json umn/source doc/build/json/umn sphinx-build -W --keep-going -b json umn/source doc/build/json/umn
# Drop data useless for the search # Drop data useless for the search - wrap it also with sh/xargs due to bugs
find doc/build/json -type d -and ( -name '_images' -or -name '_static' -or -name '_sources' ) -exec rm {:} ; # in tox
sh -c "find doc/build/json -type d -and '(' -name '_images' -or -name '_static' -or -name '_sources' ')' -print0 | xargs -0 rm -rf"
mkdir -p umn/build/json mkdir -p umn/build/json
cp -av doc/build/json/umn umn/build/json cp -av doc/build/json/umn umn/build/json

View File

@ -94,6 +94,9 @@ html_title = "Distributed Cache Service - User Guide"
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static'] html_static_path = ['_static']
# Do not include sources into the rendered results
html_copy_source = False
# -- Options for PDF output -------------------------------------------------- # -- Options for PDF output --------------------------------------------------
latex_documents = [ latex_documents = [
('index', ('index',