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,13 @@
-=============================================
+GaussDB (for MySQL)
-Welcome to the documentation of gaussdb-mysql
+===================
-=============================================
+
+GaussDB(for MySQL) is the latest generation enterprise-class distributed database. It is fully compatible with MySQL and provides high scalability and massive storage capacity. It uses a decoupled compute and storage architecture and supports up to 128 TB of storage. With GaussDB(for MySQL), there is no need to deal with sharding, and no need to worry about data loss. It combines the performance and availability of commercial databases with the cost-effectiveness of open source databases.
+
+.. directive_wrapper::
+   :class: container-sbv
+
+   .. service_card::
+      :service_type: gaussdb_mysql
+      :umn: This document describes basic concepts, functions, key terms, and FAQs of GaussDB(for MySQL) and provides instructions for applying for and using GaussDB(for MySQL).
+      :api-ref: This document describes application programming interfaces (APIs) of GaussDB(for MySQL) 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/gaussdb_mysql-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