forked from docs/virtual-private-cloud
Compare commits
2 Commits
Author | SHA1 | Date | |
---|---|---|---|
9b9dacff48 | |||
b916fe3df8 |
@ -9,6 +9,7 @@ The Virtual Private Cloud (VPC) service enables you to provision logically isola
|
||||
|
||||
.. service_card::
|
||||
:service_type: vpc
|
||||
:environment: internal
|
||||
:umn: This document describes Virtual Private Cloud service, helping you quickly create and properly use the service.
|
||||
:api-ref: This document describes application programming interfaces (APIs) of Virtual Private Cloud (VPC) and provides API parameter description and example values.
|
||||
|
||||
:best-practice: To use Virtual Private Cloud more securely, reliably, flexibly, and efficiently, you are advised to follow the following best practices.
|
||||
|
44
tox.ini
44
tox.ini
@ -40,6 +40,8 @@ commands =
|
||||
{[testenv:json-umn]commands}
|
||||
{[testenv:api-ref]commands}
|
||||
{[testenv:json-api-ref]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:umn-pdf-docs]commands}
|
||||
{[testenv:api-ref-pdf-docs]commands}
|
||||
{[testenv:best-practice-pdf-docs]commands}
|
||||
|
||||
|
||||
# HTML version
|
||||
@ -145,6 +148,47 @@ commands =
|
||||
cp api-ref/build/pdf/vpc-api-ref.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/vpc-best-practice.pdf doc/build/pdf/
|
||||
|
||||
|
||||
|
||||
[doc8]
|
||||
ignore = D001
|
||||
|
Loading…
x
Reference in New Issue
Block a user