oeotvos/software-repository-container
1
0
Fork 0
forked from docs/software-repository-container
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:12:21 +00:00 committed by zuul
parent 7f09b1cc12
commit 7e272d8243
2 changed files with 47 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/index.rst
View File

@ -9,5 +9,7 @@ Software Repository for Container (SWR) provides full lifecycle container image
.. service_card:: .. service_card::
:service_type: swr :service_type: swr
:environment: internal
:umn: This document introduces basic concepts of Software Repository for Container and demonstrates how to use SWR features. :umn: This document introduces basic concepts of Software Repository for Container and demonstrates how to use SWR features.
:api-ref: This document describes application programming interfaces (APIs) of Software Repository for Container and provides API parameter description andexample values. :api-ref: This document describes application programming interfaces (APIs) of Software Repository for Container and provides API parameter description andexample values.
:best-practice: To use Software Repository Container more securely, reliably, flexibly, and efficiently, you are advised to follow the following best practices.

44
tox.ini
View File

@ -40,6 +40,8 @@ commands =
{[testenv:json-api-ref]commands} {[testenv:json-api-ref]commands}
{[testenv:umn]commands} {[testenv:umn]commands}
{[testenv:json-umn]commands} {[testenv:json-umn]commands}
{[testenv:best-practice]commands}
{[testenv:json-best-practice]commands}
[testenv:docs-pdf] [testenv:docs-pdf]
deps = {[testenv:docs]deps} deps = {[testenv:docs]deps}
@ -53,6 +55,7 @@ commands =
mkdir -p doc/build/pdf mkdir -p doc/build/pdf
{[testenv:api-ref-pdf-docs]commands} {[testenv:api-ref-pdf-docs]commands}
{[testenv:umn-pdf-docs]commands} {[testenv:umn-pdf-docs]commands}
{[testenv:best-practice-pdf-docs]commands}
# HTML version # HTML version
@ -145,6 +148,47 @@ commands =
cp umn/build/pdf/swr-umn.pdf doc/build/pdf/ cp umn/build/pdf/swr-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/swr-best-practice.pdf doc/build/pdf/
[doc8] [doc8]
ignore = D001 ignore = D001