Closed otcbot[bot] closed 1 year ago
I tried my best, but could not apply the patch as is, therefore I will report you what I could not apply.
BTW, if in the diff you see removed line equal to the added line it may be caused by invisible trailing spaces. This is safe to ignore.
In most cases content of the patch remainder need to be carefully analyzed and necessary changes applied manually.
Following is the patch remainder:
diff a/umn/source/conf.py b/umn/source/conf.py (rejected hunks)
@@ -10,6 +10,10 @@
# 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
@@ -17,14 +21,11 @@ extensions = [
'otcdocstheme'
]
-html_theme = 'otcdocs'
-html_theme_options = {
-}
otcdocs_auto_name = False
otcdocs_auto_version = False
-project = 'Dummy Service' # FIXME
-otcdocs_repo_name = 'opentelekomcloud-docs/template' # FIXME
+project = 'Object Storage Service'
+otcdocs_repo_name = 'docs/object-storage-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
@@ -43,7 +44,7 @@ source_suffix = '.rst'
# The encoding of source files.
#
-# source_encoding = 'utf-8'
+source_encoding = 'utf-8'
# The master toctree document.
master_doc = 'index'
@@ -54,102 +55,42 @@ copyright = u'2022-present, Open Telekom Cloud'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
-# language = None
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-# today = ''
-# Else, today_fmt is used as the format for a strftime call.
-# today_fmt = '%B %d, %Y'
-
-# The reST default role (used for this markup: `text`) to use
-# for all documents.
-# default_role = None
+language = 'en'
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
show_authors = False
-
-# -- Options for man page output ----------------------------------------------
-
-# Grouping the document tree for man pages.
-# List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual'
-
-
# -- 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_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 = {}
-
-# Add any paths that contain custom themes here, relative to this directory.
-# html_theme_path = []
+html_theme_options = {
+ 'disable_search': True,
+ 'site_name': 'Internal Documentation Portal'
+}
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
-html_title = "Dummy UMN" # FIXME
-
-# A shorter title for the navigation bar. Default is the same as html_title.
-# html_short_title = None
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-# html_logo = None
+html_title = "Object Storage Service - User Guide"
-# The name of an image file (within the static path) to use as favicon of the
-# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-# html_favicon = None
# 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']
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-# html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-# html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-# html_additional_pages = {}
-
-# If false, no module index is generated.
-# html_use_modindex = True
-
-# If false, no index is generated.
-# html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-# html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-# html_show_sourcelink = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it. The value of this option must be the
-# base URL from which the finished HTML is served.
-# html_use_opensearch = ''
-
-# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
-# html_file_suffix = ''
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'dummydoc' # FIXME
+html_static_path = ['_static']
+# -- Options for PDF output --------------------------------------------------
latex_documents = [
- ('index',
- 'umn-dummy.tex', # FIXME
- u'%s User Manual Documentation' % project,
+('index',
+ 'obs-umn.tex',
+ u'Object Storage Service - User Guide',
u'OpenTelekomCloud', 'manual'),
-]
+]
\ No newline at end of file
This is an automatically created Pull Request for changes to object-storage-service-umn to promote changes down the pipeline to Production environment.
The original change can be found under https://gitea.eco.tsi-dev.otc-service.com/docs/object-storage-service/pulls/20.
There were patch conflicts, please review original patch file.