From 53ef9531849bcbc99a4a078b355f7f528f8f0601 Mon Sep 17 00:00:00 2001 From: proposalbot Date: Mon, 5 Sep 2022 10:29:16 +0000 Subject: [PATCH] Changes to dds_api-ref from docs/doc-exports#192 (add support for warnings) Reviewed-by: gtema Co-authored-by: proposalbot Co-committed-by: proposalbot --- .../source/_static/{images => }/.placeholder | 0 api-ref/source/conf.py | 110 ++++-------------- api-ref/source/docutils.conf | 2 +- api-ref/source/index.rst | 6 +- 4 files changed, 25 insertions(+), 93 deletions(-) rename api-ref/source/_static/{images => }/.placeholder (100%) diff --git a/api-ref/source/_static/images/.placeholder b/api-ref/source/_static/.placeholder similarity index 100% rename from api-ref/source/_static/images/.placeholder rename to api-ref/source/_static/.placeholder diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index a69bee6..c8f02a0 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -10,23 +10,22 @@ # 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 = [ - 'otc_api_ref', 'otcdocstheme' ] - -html_theme = 'otcdocs' -html_theme_options = { - "sidebar_mode": "toctree" -} otcdocs_auto_name = False -project = 'Dummy Service' # FIXME -otcdocs_repo_name = 'opentelekomcloud-docs/template' # FIXME +otcdocs_auto_version = False +project = 'Document Database Service' +otcdocs_repo_name = 'docs/document-database-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 @@ -45,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' @@ -56,109 +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 - -# 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 = False +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 # " v documentation". -# html_title = None -# A shorter title for the navigation bar. Default is the same as html_title. -# html_short_title = None +html_title = "Document Database Service - API Reference" -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -# html_logo = None - -# 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 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', - 'api-ref-dummy.tex', # FIXME - u'%s API Reference' % project, +('index', + 'dds-api-ref.tex', + u'Document Database Service - API Reference', u'OpenTelekomCloud', 'manual'), -] +] \ No newline at end of file diff --git a/api-ref/source/docutils.conf b/api-ref/source/docutils.conf index 808c9d2..7cbe4c1 100644 --- a/api-ref/source/docutils.conf +++ b/api-ref/source/docutils.conf @@ -1,2 +1,2 @@ [html writers] -table-style: table, caption-top +table-style: table, caption-top \ No newline at end of file diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index da000cf..e3b6621 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -1,4 +1,4 @@ -TODO -#### +========================================= +Document Database Service - API Reference +========================================= -TODO