From 52453e51aef6a7b651971083777e82bfd056ed99 Mon Sep 17 00:00:00 2001 From: OpenTelekomCloud Proposal Bot Date: Mon, 23 Oct 2023 12:32:08 +0000 Subject: [PATCH] Update content --- doc/best-practice/source/_static/.placeholder | 0 doc/best-practice/source/conf.py | 117 ++++++++++++++++++ doc/best-practice/source/docutils.conf | 2 + doc/best-practice/source/index.rst | 4 + 4 files changed, 123 insertions(+) create mode 100644 doc/best-practice/source/_static/.placeholder create mode 100644 doc/best-practice/source/conf.py create mode 100644 doc/best-practice/source/docutils.conf create mode 100644 doc/best-practice/source/index.rst diff --git a/doc/best-practice/source/_static/.placeholder b/doc/best-practice/source/_static/.placeholder new file mode 100644 index 0000000..e69de29 diff --git a/doc/best-practice/source/conf.py b/doc/best-practice/source/conf.py new file mode 100644 index 0000000..c5f532d --- /dev/null +++ b/doc/best-practice/source/conf.py @@ -0,0 +1,117 @@ +# 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. +# +# !!! +# This file is generated out of template in doc-exports repository. +# Beware overwriting it locally. + +import os +import sys + +extensions = [ + 'otcdocstheme', +] + +otcdocs_auto_name = False +otcdocs_auto_version = False + +project = 'Cloud Container Engine' +otcdocs_repo_name = 'docs/cloud-container-engine' +# Those variables are required for edit/bug links +otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com' +otcdocs_git_type = 'gitea' + +# Those variables are needed for indexing into OpenSearch +otcdocs_doc_environment = 'internal' +otcdocs_doc_link = '/cloud-container-engine/best-practice/' +otcdocs_doc_title = 'Best Practice' +otcdocs_doc_type = 'best-practice' +otcdocs_service_category = 'container' +otcdocs_service_title = 'Cloud Container Engine' +otcdocs_service_type = 'cce' +otcdocs_search_environment = 'hc_de' +otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/" + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath('../../')) +sys.path.insert(0, os.path.abspath('../')) +sys.path.insert(0, os.path.abspath('./')) + +# -- General configuration ---------------------------------------------------- +# https://docutils.sourceforge.io/docs/user/smartquotes.html - it does not +# what it is expected +smartquotes = False + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +# +source_encoding = 'utf-8' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +copyright = u'2022-present, Open Telekom Cloud' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +language = 'en' + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +show_authors = False + +# -- 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 = 'otcdocs' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +html_theme_options = { + "disable_search": True, + "site_name": "Internal Documentation Portal", + "logo_url": "https://docs-int.otc-service.com", +} + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". + +html_title = "Cloud Container Engine - Best Practice" + + +# Add any paths that contain custom static files (such as style sheets) here, +# 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'] + +# Do not include sources into the rendered results +html_copy_source = False + +# -- Options for PDF output -------------------------------------------------- +latex_documents = [ + ('index', + 'cce-best-practice.tex', + u'Cloud Container Engine - Best Practice', + u'OpenTelekomCloud', 'manual'), +] diff --git a/doc/best-practice/source/docutils.conf b/doc/best-practice/source/docutils.conf new file mode 100644 index 0000000..7cbe4c1 --- /dev/null +++ b/doc/best-practice/source/docutils.conf @@ -0,0 +1,2 @@ +[html writers] +table-style: table, caption-top \ No newline at end of file diff --git a/doc/best-practice/source/index.rst b/doc/best-practice/source/index.rst new file mode 100644 index 0000000..20c2051 --- /dev/null +++ b/doc/best-practice/source/index.rst @@ -0,0 +1,4 @@ +====================================== +Cloud Container Engine - Best Practice +====================================== +