lboka/document-database-service
1
0
Fork 0
forked from docs/document-database-service
Code Pull Requests Activity

Service Based View

Browse Source 
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-committed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
This commit is contained in:
Gode, Sebastian 2023-05-09 15:10:10 +00:00 committed by zuul
parent 170aa8b37d
commit 0b6e64f33f
7 changed files with 131 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
api-ref/source/conf.py
View File

@ -18,7 +18,7 @@ import os
import sys
extensions = [
'otcdocstheme'
'otcdocstheme',
]
otcdocs_auto_name = False
@ -98,9 +98,4 @@ html_static_path = ['_static']
html_copy_source = False
# -- Options for PDF output --------------------------------------------------
latex_documents = [
('index',
'None.tex',
u'Document Database Service - API Reference',
u'OpenTelekomCloud', 'manual'),
]
latex_documents = []

5
doc/requirements.txt
View File

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

0
doc/source/_static/placeholder Normal file
View File

102
doc/source/conf.py Normal file
View File

File diff suppressed because it is too large Load Diff

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

@ -0,0 +1,13 @@
Document Database Service
=========================
Document Database Service (DDS) is a cloud computing-based NoSQL database featuring high performance storage, high availability architecture, and disaster recovery failover, along with online scaling, backup, and restoration capabilities. It has a mature performance monitoring system, a multi-level security protection mechanism, and a professional database management platform.
.. directive_wrapper::
:class: container-sbv
.. service_card::
:service_type: dds
:umn: This document describes basic concepts, functions, key terms, and FAQs of Document Database Service (DDS) and provides instructions for applying for and using DDS.
:api-ref: This document describes application programming interfaces (APIs) of Document Database Service (DDS) and provides API parameter description and example values.

9
tox.ini
View File

@ -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}
@ -120,3 +124,8 @@ commands =
mkdir -p doc/build/pdf
cp umn/build/pdf/dds-umn.pdf doc/build/pdf/
[doc8]
ignore = D001
extensions = .rst, .yaml

2
umn/source/conf.py
View File

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