lboka/document-database-service
1
0
Fork 0
forked from docs/document-database-service
Code Pull Requests Activity

adding best-practice to sbv

Browse Source 
Reviewed-by: vladimirhasko <vladimirhasko@gmail.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
This commit is contained in:
Hasko, Vladimir 2023-10-24 22:16:22 +00:00 committed by zuul
parent 0283a84ece
commit 8951b1eb57
3 changed files with 47 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
api-ref/source/conf.py
View File

@ -109,9 +109,4 @@ html_static_path = ['_static']
html_copy_source = False
# -- Options for PDF output --------------------------------------------------
latex_documents = [
('index',
'None.tex',
u'Document Database Service - API Reference',
u'OpenTelekomCloud', 'manual'),
]
latex_documents = []

3
doc/source/index.rst
View File

@ -8,6 +8,7 @@ Document Database Service (DDS) is a cloud computing-based NoSQL database featur
.. service_card::
:service_type: dds
:environment: internal
:umn: This document describes basic concepts, functions, key terms, and FAQs of Document Database Service (DDS) and provides instructions for applying for and using DDS.
:api-ref: This document describes application programming interfaces (APIs) of Document Database Service (DDS) and provides API parameter description and example values.
:best-practice: To use Document Database Service more securely, reliably, flexibly, and efficiently, you are advised to follow the following best practices.

44
tox.ini
View File

@ -38,6 +38,8 @@ commands =
sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html
{[testenv:umn]commands}
{[testenv:json-umn]commands}
{[testenv:best-practice]commands}
{[testenv:json-best-practice]commands}
{[testenv:api-ref]commands}
{[testenv:json-api-ref]commands}
@ -52,6 +54,7 @@ allowlist_externals =
commands =
mkdir -p doc/build/pdf
{[testenv:umn-pdf-docs]commands}
{[testenv:best-practice-pdf-docs]commands}
# HTML version
@ -99,6 +102,47 @@ commands =
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
[testenv:api-ref]
deps = {[testenv:docs]deps}