diff --git a/doc/source/index.rst b/doc/source/index.rst index c4093c3..c73d0f0 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -9,5 +9,7 @@ Software Repository for Container (SWR) provides full lifecycle container image .. service_card:: :service_type: swr + :environment: internal :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. \ No newline at end of file + :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. diff --git a/tox.ini b/tox.ini index 860d0f3..0e98b8b 100644 --- a/tox.ini +++ b/tox.ini @@ -40,6 +40,8 @@ commands = {[testenv:json-api-ref]commands} {[testenv:umn]commands} {[testenv:json-umn]commands} + {[testenv:best-practice]commands} + {[testenv:json-best-practice]commands} [testenv:docs-pdf] deps = {[testenv:docs]deps} @@ -53,6 +55,7 @@ commands = mkdir -p doc/build/pdf {[testenv:api-ref-pdf-docs]commands} {[testenv:umn-pdf-docs]commands} + {[testenv:best-practice-pdf-docs]commands} # HTML version @@ -145,6 +148,47 @@ commands = 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] ignore = D001