Compare commits

...

3 Commits

Author SHA1 Message Date
2fc19c80e0 Update '/doc/source/index.rst' remove dev part 2023-05-10 11:58:23 +00:00
17f861294f Update '/doc/source/index.rst' 2023-05-10 11:29:01 +00:00
SebastianGode
7db058f4cd Add Service-Based-View to the service 2023-05-08 14:53:06 +02:00
7 changed files with 131 additions and 3 deletions

View File

@ -18,7 +18,7 @@ import os
import sys import sys
extensions = [ extensions = [
'otcdocstheme' 'otcdocstheme',
] ]
otcdocs_auto_name = False otcdocs_auto_name = False

View File

@ -2,3 +2,6 @@ sphinx>=2.0.0,!=2.1.0 # BSD
otcdocstheme # Apache-2.0 otcdocstheme # Apache-2.0
# releasenotes # releasenotes
reno>=3.1.0 # Apache-2.0 reno>=3.1.0 # Apache-2.0
otc-sphinx-directives>=0.1.0
git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata

View File

102
doc/source/conf.py Normal file

File diff suppressed because it is too large Load Diff

14
doc/source/index.rst Normal file
View File

@ -0,0 +1,14 @@
Virtual Private Cloud
=====================
The Virtual Private Cloud (VPC) service enables you to provision logically isolated, configurable, and manageable virtual networks for Elastic Cloud Servers (ECSs), improving the security of resources in the cloud system and simplifying network deployment.
.. directive_wrapper::
:class: container-sbv
.. service_card::
:service_type: vpc
: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.

View File

@ -29,7 +29,11 @@ allowlist_externals =
mkdir mkdir
cp cp
sh sh
rm
sphinx-build
commands = commands =
rm -rf doc/build/html doc/build/doctrees
sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html
{[testenv:api-ref]commands} {[testenv:api-ref]commands}
{[testenv:json-api-ref]commands} {[testenv:json-api-ref]commands}
{[testenv:umn]commands} {[testenv:umn]commands}
@ -138,3 +142,8 @@ commands =
mkdir -p doc/build/pdf mkdir -p doc/build/pdf
cp umn/build/pdf/vpc-umn.pdf doc/build/pdf/ cp umn/build/pdf/vpc-umn.pdf doc/build/pdf/
[doc8]
ignore = D001
extensions = .rst, .yaml

View File

@ -18,7 +18,7 @@ import os
import sys import sys
extensions = [ extensions = [
'otcdocstheme' 'otcdocstheme',
] ]
otcdocs_auto_name = False otcdocs_auto_name = False