From f5f41a6cfca686cbf593a983dcefb040bfeba599 Mon Sep 17 00:00:00 2001 From: proposalbot Date: Mon, 5 Sep 2022 10:03:37 +0000 Subject: [PATCH] Changes to mrs_dummy from docs/doc-exports#192 (add support for warnings) Reviewed-by: gtema Co-authored-by: proposalbot Co-committed-by: proposalbot --- .../_static/.placeholder | 0 docs/mrs/component-operation-guide/conf.py | 96 +++++++++++++++++++ .../component-operation-guide/docutils.conf | 2 + docs/mrs/component-operation-guide/index.rst | 4 + 4 files changed, 102 insertions(+) create mode 100644 docs/mrs/component-operation-guide/_static/.placeholder create mode 100644 docs/mrs/component-operation-guide/conf.py create mode 100644 docs/mrs/component-operation-guide/docutils.conf create mode 100644 docs/mrs/component-operation-guide/index.rst diff --git a/docs/mrs/component-operation-guide/_static/.placeholder b/docs/mrs/component-operation-guide/_static/.placeholder new file mode 100644 index 0000000..e69de29 diff --git a/docs/mrs/component-operation-guide/conf.py b/docs/mrs/component-operation-guide/conf.py new file mode 100644 index 0000000..bdce674 --- /dev/null +++ b/docs/mrs/component-operation-guide/conf.py @@ -0,0 +1,96 @@ +# 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 = 'Map Reduce Service' +otcdocs_repo_name = 'docs/mapreduce-service' + +# 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 ---------------------------------------------------- + +# 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' +} + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". + +html_title = "Map Reduce Service - Component Operation Guide" + + +# 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'] + +# -- Options for PDF output -------------------------------------------------- +latex_documents = [ +('index', + 'mrs-component-operation-guide.tex', + u'Map Reduce Service - Component Operation Guide', + u'OpenTelekomCloud', 'manual'), +] \ No newline at end of file diff --git a/docs/mrs/component-operation-guide/docutils.conf b/docs/mrs/component-operation-guide/docutils.conf new file mode 100644 index 0000000..7cbe4c1 --- /dev/null +++ b/docs/mrs/component-operation-guide/docutils.conf @@ -0,0 +1,2 @@ +[html writers] +table-style: table, caption-top \ No newline at end of file diff --git a/docs/mrs/component-operation-guide/index.rst b/docs/mrs/component-operation-guide/index.rst new file mode 100644 index 0000000..02742bc --- /dev/null +++ b/docs/mrs/component-operation-guide/index.rst @@ -0,0 +1,4 @@ +============================================== +Map Reduce Service - Component Operation Guide +============================================== +