Add Service-Based-View to the service

This commit is contained in:
SebastianGode 2023-05-08 14:49:21 +02:00
parent 170aa8b37d
commit a19f8b1a9c
7 changed files with 126 additions and 9 deletions

View File

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

View File

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

View File

102
doc/source/conf.py Normal file

File diff suppressed because it is too large Load Diff

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

@ -0,0 +1,8 @@
Document Database Service
=========================
.. directive_wrapper::
:class: container-sbv
.. service_card::
:service_type: dds

View File

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

View File

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