Update tox.ini && conf.py file

Reviewed-by: tischrei <tino.schreiber@t-systems.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
@@ -30,6 +30,17 @@ otcdocs_repo_name = 'docs/distributed-database-middleware'
 otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
 otcdocs_git_type = 'gitea'
 
+# Those variables are needed for indexing into OpenSearch
+otcdocs_doc_environment = 'internal'
+otcdocs_doc_link = '/distributed-database-middleware/api-ref/'
+otcdocs_doc_title = 'API Reference'
+otcdocs_doc_type = 'api-ref'
+otcdocs_service_category = 'database'
+otcdocs_service_title = 'Distributed Database Middleware'
+otcdocs_service_type = 'ddm'
+otcdocs_search_environment = 'hc_de'
+otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/"
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.

api-ref/source/docutils.conf

@@ -0,0 +1,2 @@
+[html writers]
+table-style: table, caption-top

api-ref/source/index.rst

@@ -1,3 +1,4 @@
-===============================================================
-Welcome to the documentation of distributed-database-middleware
-===============================================================
+===============================================
+Distributed Database Middleware - API Reference
+===============================================
+

doc/requirements.txt

@@ -1,4 +1,11 @@
 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
+sphinx-minify>=0.0.1 # Apache-2.0
+git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata
+setuptools

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.