Update tox.ini && conf.py file
Performed-by: gitea/infra/otc-metadata/tools/generate_doc_confpy.py
This commit is contained in:
parent
0283a84ece
commit
87e27bcc35
@ -109,9 +109,4 @@ html_static_path = ['_static']
|
|||||||
html_copy_source = False
|
html_copy_source = False
|
||||||
|
|
||||||
# -- Options for PDF output --------------------------------------------------
|
# -- Options for PDF output --------------------------------------------------
|
||||||
latex_documents = [
|
latex_documents = []
|
||||||
('index',
|
|
||||||
'None.tex',
|
|
||||||
u'Document Database Service - API Reference',
|
|
||||||
u'OpenTelekomCloud', 'manual'),
|
|
||||||
]
|
|
||||||
|
44
tox.ini
44
tox.ini
@ -38,6 +38,8 @@ commands =
|
|||||||
sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html
|
sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html
|
||||||
{[testenv:umn]commands}
|
{[testenv:umn]commands}
|
||||||
{[testenv:json-umn]commands}
|
{[testenv:json-umn]commands}
|
||||||
|
{[testenv:best-practice]commands}
|
||||||
|
{[testenv:json-best-practice]commands}
|
||||||
{[testenv:api-ref]commands}
|
{[testenv:api-ref]commands}
|
||||||
{[testenv:json-api-ref]commands}
|
{[testenv:json-api-ref]commands}
|
||||||
|
|
||||||
@ -52,6 +54,7 @@ allowlist_externals =
|
|||||||
commands =
|
commands =
|
||||||
mkdir -p doc/build/pdf
|
mkdir -p doc/build/pdf
|
||||||
{[testenv:umn-pdf-docs]commands}
|
{[testenv:umn-pdf-docs]commands}
|
||||||
|
{[testenv:best-practice-pdf-docs]commands}
|
||||||
|
|
||||||
|
|
||||||
# HTML version
|
# HTML version
|
||||||
@ -99,6 +102,47 @@ commands =
|
|||||||
cp umn/build/pdf/dds-umn.pdf doc/build/pdf/
|
cp umn/build/pdf/dds-umn.pdf doc/build/pdf/
|
||||||
|
|
||||||
|
|
||||||
|
# HTML version
|
||||||
|
[testenv:best-practice]
|
||||||
|
deps = {[testenv:docs]deps}
|
||||||
|
allowlist_externals =
|
||||||
|
cp
|
||||||
|
mkdir
|
||||||
|
commands =
|
||||||
|
sphinx-build -W --keep-going -b html doc/best-practice/source doc/build/html/best-practice
|
||||||
|
|
||||||
|
# Json version (for search)
|
||||||
|
[testenv:json-best-practice]
|
||||||
|
deps = {[testenv:docs]deps}
|
||||||
|
allowlist_externals =
|
||||||
|
cp
|
||||||
|
mkdir
|
||||||
|
sh
|
||||||
|
commands =
|
||||||
|
sphinx-build -W --keep-going -b json doc/best-practice/source doc/build/json/best-practice
|
||||||
|
# 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:best-practice-pdf-docs]
|
||||||
|
deps = {[testenv:docs]deps}
|
||||||
|
allowlist_externals =
|
||||||
|
rm
|
||||||
|
mkdir
|
||||||
|
make
|
||||||
|
bash
|
||||||
|
cp
|
||||||
|
commands =
|
||||||
|
rm -rf doc/best-practice/build/pdf
|
||||||
|
sphinx-build -W --keep-going -b latex doc/best-practice/source doc/best-practice/build/pdf/
|
||||||
|
bash -c "for f in doc/best-practice/build/pdf/*.gif; do convert $f $\{f/%gif/png\}; done || true"
|
||||||
|
bash -c "for f in doc/best-practice/build/pdf/*.tex; do sed -iorig 's/\.gif//g' $f; done"
|
||||||
|
make -C doc/best-practice/build/pdf
|
||||||
|
mkdir -p doc/build/pdf
|
||||||
|
cp doc/best-practice/build/pdf/dds-best-practice.pdf doc/build/pdf/
|
||||||
|
|
||||||
|
|
||||||
# HTML version
|
# HTML version
|
||||||
[testenv:api-ref]
|
[testenv:api-ref]
|
||||||
deps = {[testenv:docs]deps}
|
deps = {[testenv:docs]deps}
|
||||||
|
Loading…
x
Reference in New Issue
Block a user