Service Based View

Reviewed-by: Eotvos, Oliver <oliver.eotvos@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-11 13:15:35 +00:00 committed by zuul
parent ad71cf3710
commit 99e5f0fcc6
7 changed files with 130 additions and 3 deletions

View File

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

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

View File

102
doc/source/conf.py Normal file

File diff suppressed because it is too large Load Diff

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

@ -0,0 +1,13 @@
Software Repository for Container
=================================
Software Repository for Container (SWR) provides full lifecycle container image management, which is easy-to-use, secure, and reliable. SWR enables users to uickly deploy containerized services.
.. directive_wrapper::
:class: container-sbv
.. service_card::
:service_type: swr
:umn: This document introduces basic concepts of Software Repository for Container and demonstrates how to use SWR features.
:api-ref: This document describes application programming interfaces (APIs) of Software Repository for Container and provides API parameter description andexample values.

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

View File

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