forked from docs/mapreduce-service
Update tox.ini && conf.py file
Performed-by: gitea/infra/otc-metadata/tools/generate_doc_confpy.py
This commit is contained in:
parent
f5c3c21c0b
commit
0ff70f9bde
@ -94,6 +94,9 @@ html_title = "Map Reduce Service - 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',
|
||||
|
@ -94,6 +94,9 @@ html_title = "Map Reduce Service - Component Operation 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',
|
||||
|
31
tox.ini
31
tox.ini
@ -21,8 +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
|
||||
sh
|
||||
commands =
|
||||
{[testenv:api-ref]commands}
|
||||
{[testenv:json-api-ref]commands}
|
||||
@ -34,7 +40,11 @@ commands =
|
||||
[testenv:docs-pdf]
|
||||
deps = -r{toxinidir}/doc/requirements.txt
|
||||
allowlist_externals =
|
||||
rm
|
||||
mkdir
|
||||
make
|
||||
bash
|
||||
cp
|
||||
commands =
|
||||
mkdir -p doc/build/pdf
|
||||
{[testenv:api-ref-pdf-docs]commands}
|
||||
@ -59,11 +69,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
|
||||
|
||||
@ -101,11 +112,12 @@ deps = -r{toxinidir}/doc/requirements.txt
|
||||
allowlist_externals =
|
||||
cp
|
||||
mkdir
|
||||
find
|
||||
sh
|
||||
commands =
|
||||
sphinx-build -W --keep-going -b json doc/component-operation-guide/source doc/build/json/operation-guide
|
||||
# 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"
|
||||
|
||||
# PDF version
|
||||
[testenv:operation-guide-pdf-docs]
|
||||
@ -143,11 +155,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 = "Map Reduce Service - 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