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/requirements.txt

@@ -8,5 +8,4 @@ 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
-gitpython
+setuptools

doc/source/conf.py

@@ -16,8 +16,6 @@
 
 import os
 import sys
-from git import Repo
-from datetime import datetime
 
 extensions = [
     'otcdocstheme',
@@ -107,29 +105,9 @@ html_title = "Regions and Endpoints - Service Based View"
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
-templates_path = ['_templates']
 
 # Do not include sources into the rendered results
 html_copy_source = False
 
 # -- Options for PDF output --------------------------------------------------
 latex_documents = []
-
-# Get the Git commit values for last updated timestamp on each page
-repo = Repo(search_parent_directories=True)
-commit = repo.head.commit
-current_commit_hash = commit.hexsha
-current_commit_time = commit.committed_datetime.strftime('%Y-%m-%d %H:%M')
-
-latex_elements = {
-  'papersize': 'a4paper',
-  'pointsize': '12pt',
-  'figure_align': 'H',
-  'preamble': rf'''
-        \newcommand{{\githash}}{{{current_commit_hash}}}
-        \newcommand{{\gitcommittime}}{{{current_commit_time}}}
-        \newcommand{{\doctitle}}{{{otcdocs_doc_title}}}
-        \newcommand{{\servicetitle}}{{{otcdocs_service_title}}}
-  ''',
-  'sphinxsetup': 'hmargin={15mm,15mm}, vmargin={20mm,30mm}, marginpar=10mm'
-}

tox.ini

@@ -13,8 +13,6 @@ commands = stestr run {posargs}
   stestr slowest
 
 [testenv:pep8]
-allowlist_externals =
-  doc8
 commands =
   doc8 doc/source README.rst
 
@@ -54,10 +52,6 @@ allowlist_externals =
 commands =
   mkdir -p doc/build/pdf
   {[testenv:bindeps]commands}
-  mkdir -p {toxinidir}/_templates
-  wget -O {toxinidir}/_templates/longtable.tex.jinja https://gitea.eco.tsi-dev.otc-service.com/infra/docs-templates/raw/branch/main/templates/longtable.tex.jinja
-  wget -O {toxinidir}/_templates/tabular.tex.jinja https://gitea.eco.tsi-dev.otc-service.com/infra/docs-templates/raw/branch/main/templates/tabular.tex.jinja
-  wget -O {toxinidir}/_templates/tabulary.tex.jinja https://gitea.eco.tsi-dev.otc-service.com/infra/docs-templates/raw/branch/main/templates/tabulary.tex.jinja
 
 
 

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
+=====================================================

zuul.yaml

@@ -1,4 +1,3 @@
----
 - project:
     merge-mode: squash-merge
     default-branch: main
@@ -9,4 +8,4 @@
         - noop
     gate:
       jobs:
-        - noop
+        - noop