Service Based View

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

@@ -2,3 +2,6 @@ sphinx>=2.0.0,!=2.1.0 # BSD
 otcdocstheme # Apache-2.0
 # releasenotes
 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

@@ -1,3 +1,12 @@
-===============================================================
-Welcome to the documentation of distributed-database-middleware
-===============================================================
+Distributed Database Middleware
+===============================
+
+Distributed Database Middleware (DDM) removes database capacity and performance bottlenecks and resolves distributed expansion issues. It provides database and table sharding, read/write splitting, and elastic scaling, helping you handle highly concurrent access to massive volumes of data and improving database read/write performance.
+
+.. directive_wrapper::
+   :class: container-sbv
+
+   .. service_card::
+      :service_type: ddm
+      :umn: This document describes basic concepts, functions, key terms, and FAQs of Distributed Database Middleware (DDM) and provides instructions for applying for and using DDM.
+      :api-ref: This document describes application programming interfaces (APIs) of Distributed Database Middleware (DDM) 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/ddm-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