Initial import

doc/source/admin/index.rst

@@ -0,0 +1,5 @@
+====================
+Administrators guide
+====================
+
+Administrators guide of ssh://git@gitea.eco.tsi-dev.otc-service.com:2222/infra/otc-metadata.git.

doc/source/cli/index.rst

@@ -0,0 +1,5 @@
+================================
+Command line interface reference
+================================
+
+CLI reference of ssh://git@gitea.eco.tsi-dev.otc-service.com:2222/infra/otc-metadata.git.

doc/source/conf.py

@@ -0,0 +1,76 @@
+# -*- 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',
+    #'sphinx.ext.intersphinx',
+]
+
+# 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 = 'ssh://git@gitea.eco.tsi-dev.otc-service.com:2222/infra/otc-metadata.git'
+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}

doc/source/configuration/index.rst

@@ -0,0 +1,5 @@
+=============
+Configuration
+=============
+
+Configuration of ssh://git@gitea.eco.tsi-dev.otc-service.com:2222/infra/otc-metadata.git.

doc/source/contributor/contributing.rst

@@ -0,0 +1,5 @@
+============================
+So You Want to Contribute...
+============================
+
+TODO

doc/source/contributor/index.rst

@@ -0,0 +1,9 @@
+===========================
+ Contributor Documentation
+===========================
+
+.. toctree::
+   :maxdepth: 2
+
+   contributing
+

doc/source/index.rst

@@ -0,0 +1,30 @@
+.. ssh://git@gitea.eco.tsi-dev.otc-service.com:2222/infra/otc-metadata.git documentation master file, created by
+   sphinx-quickstart on Tue Jul  9 22:26:36 2013.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+============================================
+Welcome to the documentation of otc-metadata
+============================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   readme
+   install/index
+   library/index
+   contributor/index
+   configuration/index
+   cli/index
+   user/index
+   admin/index
+   reference/index
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

doc/source/install/index.rst

@@ -0,0 +1,14 @@
+================================================
+ {{cookiecutter.module_name}} installation guide
+================================================
+
+.. toctree::
+   :maxdepth: 2
+
+   install.rst
+
+The otc-metadata provides...
+
+This chapter assumes a working setup of OpenStack following the
+`OpenStack Installation Tutorial
+<https://docs.openstack.org/project-install-guide/ocata/>`_.

doc/source/install/install.rst

@@ -0,0 +1,13 @@
+.. _install:
+
+Install and configure
+~~~~~~~~~~~~~~~~~~~~~
+
+This section describes how to install and configure the
+otc-metadata.
+
+This section assumes that you already have a working OpenStack
+environment with at least the following components installed:
+.. (add the appropriate services here and further notes)
+
+Note that installation and configuration vary by distribution.

doc/source/library/index.rst

@@ -0,0 +1,7 @@
+========
+Usage
+========
+
+To use ssh://git@gitea.eco.tsi-dev.otc-service.com:2222/infra/otc-metadata.git in a project::
+
+    import otc-metadata

doc/source/readme.rst

@@ -0,0 +1 @@
+.. include:: ../../README.rst

doc/source/reference/index.rst

@@ -0,0 +1,5 @@
+==========
+References
+==========
+
+References of ssh://git@gitea.eco.tsi-dev.otc-service.com:2222/infra/otc-metadata.git.

doc/source/user/index.rst

@@ -0,0 +1,5 @@
+===========
+Users guide
+===========
+
+Users guide of ssh://git@gitea.eco.tsi-dev.otc-service.com:2222/infra/otc-metadata.git.