Service Based View

Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-committed-by: Gode, Sebastian <sebastian.gode@t-systems.com>

api-ref/source/conf.py

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

doc/requirements.txt

@@ -1,4 +1,7 @@
 sphinx>=2.0.0,!=2.1.0 # BSD
 otcdocstheme # Apache-2.0
 # 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

doc/source/index.rst

@@ -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.
+

tox.ini

@@ -29,7 +29,11 @@ allowlist_externals =
   mkdir
   cp
   sh
+  rm
+  sphinx-build
 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:json-api-ref]commands}
   {[testenv:umn]commands}
@@ -138,3 +142,8 @@ commands =
   mkdir -p doc/build/pdf
   cp umn/build/pdf/vpc-umn.pdf doc/build/pdf/
 
+
+
+[doc8]
+ignore = D001
+extensions = .rst, .yaml

umn/source/conf.py

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