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:
parent
168301a58b
commit
0438c9f526
@ -94,6 +94,9 @@ html_title = "Dedicated Web Application Firewall - API Reference"
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
|
||||
# Do not include sources into the rendered results
|
||||
html_copy_source = False
|
||||
|
||||
# -- Options for PDF output --------------------------------------------------
|
||||
latex_documents = [
|
||||
('index',
|
||||
|
18
tox.ini
18
tox.ini
@ -21,12 +21,14 @@ deps =
|
||||
-r{toxinidir}/requirements.txt
|
||||
commands = {posargs}
|
||||
|
||||
# This env is invoked in the periodic pipeline and is therefore responsible to
|
||||
# build all relevant docs at once.
|
||||
[testenv:docs]
|
||||
deps = -r{toxinidir}/doc/requirements.txt
|
||||
allowlist_externals =
|
||||
mkdir
|
||||
cp
|
||||
find
|
||||
sh
|
||||
commands =
|
||||
{[testenv:api-ref]commands}
|
||||
{[testenv:json-api-ref]commands}
|
||||
@ -64,11 +66,12 @@ deps = -r{toxinidir}/doc/requirements.txt
|
||||
allowlist_externals =
|
||||
cp
|
||||
mkdir
|
||||
find
|
||||
sh
|
||||
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 {:} ;
|
||||
# Drop data useless for the search - wrap it also with sh/xargs due to bugs
|
||||
# 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
|
||||
cp -av doc/build/json/api-ref api-ref/build/json
|
||||
|
||||
@ -108,11 +111,12 @@ deps = -r{toxinidir}/doc/requirements.txt
|
||||
allowlist_externals =
|
||||
cp
|
||||
mkdir
|
||||
find
|
||||
sh
|
||||
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 {:} ;
|
||||
# Drop data useless for the search - wrap it also with sh/xargs due to bugs
|
||||
# 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
|
||||
cp -av doc/build/json/umn umn/build/json
|
||||
|
||||
|
@ -94,6 +94,9 @@ html_title = "Dedicated Web Application Firewall - User Guide"
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
|
||||
# Do not include sources into the rendered results
|
||||
html_copy_source = False
|
||||
|
||||
# -- Options for PDF output --------------------------------------------------
|
||||
latex_documents = [
|
||||
('index',
|
||||
|
Loading…
x
Reference in New Issue
Block a user