Update tox.ini && conf.py file

Performed-by: gitea/infra/otc-metadata/tools/generate_doc_confpy.py

api-ref/requirements.txt

@@ -0,0 +1,4 @@
+sphinx>=2.0.0,!=2.1.0 # BSD
+otcdocstheme>=1.0.0 # Apache-2.0
+# releasenotes
+reno>=3.1.0 # Apache-2.0

api-ref/source/conf.py

@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('../..'))
+# -- General configuration ----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'otcdocstheme',
+]
+
+# autodoc generation is a bit aggressive and a nuisance when doing heavy
+# text edit cycles.
+# execute "export SPHINX_DEBUG=1" in your terminal to disable
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'regions-and-endpoints'
+copyright = '2022, Open Telekom Cloud Developers'
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+add_module_names = True
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'native'
+
+# -- Options for HTML output --------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+# html_theme_path = ["."]
+# html_theme = '_theme'
+# html_static_path = ['static']
+html_theme = 'otcdocs'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = '%sdoc' % project
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass
+# [howto/manual]).
+latex_documents = [
+    ('index',
+     '%s.tex' % project,
+     '%s Documentation' % project,
+     'Open Telekom Cloud Developers', 'manual'),
+]
+
+# Example configuration for intersphinx: refer to the Python standard library.
+#intersphinx_mapping = {'http://docs.python.org/': None}

api-ref/source/index.rst

@@ -0,0 +1,3 @@
+=====================================================
+Welcome to the documentation of regions-and-endpoints
+=====================================================

dev_guide/requirements.txt

@@ -0,0 +1,4 @@
+sphinx>=2.0.0,!=2.1.0 # BSD
+otcdocstheme>=1.0.0 # Apache-2.0
+# releasenotes
+reno>=3.1.0 # Apache-2.0

dev_guide/source/conf.py

@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('../..'))
+# -- General configuration ----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'otcdocstheme',
+]
+
+# autodoc generation is a bit aggressive and a nuisance when doing heavy
+# text edit cycles.
+# execute "export SPHINX_DEBUG=1" in your terminal to disable
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'regions-and-endpoints'
+copyright = '2022, Open Telekom Cloud Developers'
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+add_module_names = True
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'native'
+
+# -- Options for HTML output --------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+# html_theme_path = ["."]
+# html_theme = '_theme'
+# html_static_path = ['static']
+html_theme = 'otcdocs'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = '%sdoc' % project
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass
+# [howto/manual]).
+latex_documents = [
+    ('index',
+     '%s.tex' % project,
+     '%s Documentation' % project,
+     'Open Telekom Cloud Developers', 'manual'),
+]
+
+# Example configuration for intersphinx: refer to the Python standard library.
+#intersphinx_mapping = {'http://docs.python.org/': None}

dev_guide/source/index.rst

@@ -0,0 +1,3 @@
+=====================================================
+Welcome to the documentation of regions-and-endpoints
+=====================================================

doc/source/index.rst

@@ -1,66 +1,3 @@
-Regions and Endpoints
+=====================================================
-=====================
+Welcome to the documentation of regions-and-endpoints
-
+=====================================================
-Region
-------
-
-+-----------------+------------+-----------------------+
-| **Region Name** | **Region** | **Availability Zone** |
-+=================+============+=======================+
-| eu-ch2          | eu-ch2     | eu-ch2a               |
-+-----------------+------------+-----------------------+
-|                 |            | eu-ch2b               |
-+-----------------+------------+-----------------------+
-
-Endpoints
----------
-
-+---------------------------------------------+---------------------+---------------+--------------------------------------------+------------------+
-| **Service Name**                            | **Region Name**     | **Region**    | **Endpoint**                               | **Protocol**     |
-+=============================================+=====================+===============+============================================+==================+
-| Application Operations Management           | eu-ch2              | eu-ch2        | aom.eu-ch2.sc.otc.t-systems.com            | HTTPS            |
-+---------------------------------------------+---------------------+---------------+--------------------------------------------+------------------+
-| Auto Scaling                                | eu-ch2              | eu-ch2        | as.eu-ch2.sc.otc.t-systems.com             | HTTPS            |
-+---------------------------------------------+---------------------+---------------+--------------------------------------------+------------------+
-| Cloud Backup and Recovery                   | eu-ch2              | eu-ch2        | cbr.eu-ch2.sc.otc.t-systems.com            | HTTPS            |
-+---------------------------------------------+---------------------+---------------+--------------------------------------------+------------------+
-| Cloud Container Engine                      | eu-ch2              | eu-ch2        | cce.eu-ch2.sc.otc.t-systems.com            | HTTPS            |
-+---------------------------------------------+---------------------+---------------+--------------------------------------------+------------------+
-| Cloud Eye                                   | eu-ch2              | eu-ch2        | ces.eu-ch2.sc.otc.t-systems.com            | HTTPS            |
-+---------------------------------------------+---------------------+---------------+--------------------------------------------+------------------+
-| Domain Name Service                         | eu-ch2              | eu-ch2        | dns.eu-ch2.sc.otc.t-systems.com            | HTTPS            |
-+---------------------------------------------+---------------------+---------------+--------------------------------------------+------------------+
-| Elastic Cloud Server                        | eu-ch2              | eu-ch2        | ecs.eu-ch2.sc.otc.t-systems.com            | HTTPS            |
-+---------------------------------------------+---------------------+---------------+--------------------------------------------+------------------+
-| Elastic Load Balancing                      | eu-ch2              | eu-ch2        | elb.eu-ch2.sc.otc.t-systems.com            | HTTPS            |
-+---------------------------------------------+---------------------+---------------+--------------------------------------------+------------------+
-| Elastic Volume Service                      | eu-ch2              | eu-ch2        | evs.eu-ch2.sc.otc.t-systems.com            | HTTPS            |
-+---------------------------------------------+---------------------+---------------+--------------------------------------------+------------------+
-| Identity and Access Management              | eu-ch2              | eu-ch2        | iam-pub.eu-ch2.sc.otc.t-systems.com        | HTTPS            |
-+---------------------------------------------+---------------------+---------------+--------------------------------------------+------------------+
-| Image Management Service                    | eu-ch2              | eu-ch2        | ims.eu-ch2.sc.otc.t-systems.com            | HTTPS            |
-+---------------------------------------------+---------------------+---------------+--------------------------------------------+------------------+
-| Key Management Service                      | eu-ch2              | eu-ch2        | kms.eu-ch2.sc.otc.t-systems.com            | HTTPS            |
-+---------------------------------------------+---------------------+---------------+--------------------------------------------+------------------+
-| NAT Gateway                                 | eu-ch2              | eu-ch2        | nat.eu-ch2.sc.otc.t-systems.com            | HTTPS            |
-+---------------------------------------------+---------------------+---------------+--------------------------------------------+------------------+
-| Object Storage Service                      | eu-ch2              | eu-ch2        | obs.eu-ch2.sc.otc.t-systems.com            | HTTPS            |
-+---------------------------------------------+---------------------+---------------+--------------------------------------------+------------------+
-| Relational Database Service                 | eu-ch2              | eu-ch2        | rds.eu-ch2.sc.otc.t-systems.com            | HTTPS            |
-+---------------------------------------------+---------------------+---------------+--------------------------------------------+------------------+
-| Storage Disaster Recovery Service           | eu-ch2              | eu-ch2        | sdrs.eu-ch2.sc.otc.t-systems.com           | HTTPS            |
-+---------------------------------------------+---------------------+---------------+--------------------------------------------+------------------+
-| Simple Message Notification                 | eu-ch2              | eu-ch2        | smn.eu-ch2.sc.otc.t-systems.com            | HTTPS            |
-+---------------------------------------------+---------------------+---------------+--------------------------------------------+------------------+
-| SoftWare Repository for Container           | eu-ch2              | eu-ch2        | swr-api.eu-ch2.sc.otc.t-systems.com        | HTTPS            |
-+---------------------------------------------+---------------------+---------------+--------------------------------------------+------------------+
-| Tag Management Service                      | eu-ch2              | eu-ch2        | tms.eu-ch2.sc.otc.t-systems.com            | HTTPS            |
-+---------------------------------------------+---------------------+---------------+--------------------------------------------+------------------+
-| Virtual Private Cloud                       | eu-ch2              | eu-ch2        | vpc.eu-ch2.sc.otc.t-systems.com            | HTTPS            |
-+---------------------------------------------+---------------------+---------------+--------------------------------------------+------------------+
-| VPC Endpoint                                | eu-ch2              | eu-ch2        | vpcep.eu-ch2.sc.otc.t-systems.com          | HTTPS            |
-+---------------------------------------------+---------------------+---------------+--------------------------------------------+------------------+
-| Virtual Private Network                     | eu-ch2              | eu-ch2        | vpn.eu-ch2.sc.otc.t-systems.com            | HTTPS            |
-+---------------------------------------------+---------------------+---------------+--------------------------------------------+------------------+
-| Web Application Firewall                    | eu-ch2              | eu-ch2        | waf.eu-ch2.sc.otc.t-systems.com            | HTTPS            |
-+---------------------------------------------+---------------------+---------------+--------------------------------------------+------------------+

umn/requirements.txt

@@ -0,0 +1,4 @@
+sphinx>=2.0.0,!=2.1.0 # BSD
+otcdocstheme>=1.0.0 # Apache-2.0
+# releasenotes
+reno>=3.1.0 # Apache-2.0

umn/source/conf.py

@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('../..'))
+# -- General configuration ----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'otcdocstheme',
+]
+
+# autodoc generation is a bit aggressive and a nuisance when doing heavy
+# text edit cycles.
+# execute "export SPHINX_DEBUG=1" in your terminal to disable
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'regions-and-endpoints'
+copyright = '2022, Open Telekom Cloud Developers'
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+add_module_names = True
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'native'
+
+# -- Options for HTML output --------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+# html_theme_path = ["."]
+# html_theme = '_theme'
+# html_static_path = ['static']
+html_theme = 'otcdocs'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = '%sdoc' % project
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass
+# [howto/manual]).
+latex_documents = [
+    ('index',
+     '%s.tex' % project,
+     '%s Documentation' % project,
+     'Open Telekom Cloud Developers', 'manual'),
+]
+
+# Example configuration for intersphinx: refer to the Python standard library.
+#intersphinx_mapping = {'http://docs.python.org/': None}

umn/source/index.rst

@@ -0,0 +1,3 @@
+=====================================================
+Welcome to the documentation of regions-and-endpoints
+=====================================================