From cdf45da5553f4daed20dc6bd8800360130c75f55 Mon Sep 17 00:00:00 2001 From: wanghao Date: Wed, 6 Jul 2022 15:59:54 +0800 Subject: [PATCH] Fix API DOC Now Zaqar's API could be finded on OpenInfra API Ref. This patch want to fix this. Change-Id: I1b60ae2c2230724a5a22ec51d5e0c32a5e4a5591 --- api-ref/source/conf.py | 150 +++------------------------------------ api-ref/source/index.rst | 24 +++---- 2 files changed, 17 insertions(+), 157 deletions(-) diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index 5a674a23d..f7c520e13 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -22,26 +22,12 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import os -import sys - -html_theme = 'openstackdocs' -html_theme_options = { - "sidebar_mode": "toc", -} extensions = [ - 'os_api_ref', 'openstackdocstheme', + 'os_api_ref', ] -# 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 @@ -50,157 +36,39 @@ sys.path.insert(0, os.path.abspath('./')) # 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. -project = u'Messaging Service API Reference' copyright = u'2010-present, OpenStack Foundation' # openstackdocstheme options openstackdocs_repo_name = 'openstack/zaqar' openstackdocs_bug_project = 'zaqar' -openstackdocs_bug_tag = '' - -# 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 - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -show_authors = False +openstackdocs_bug_tag = 'api-ref' # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'native' -# -- 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 +# 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 = 'openstackdocs' # 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 +# 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 = [] - -# 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 - -# 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 = 'zaqardoc' - +html_theme_options = { + "sidebar_mode": "toc", +} # -- Options for LaTeX output ------------------------------------------------- -# The paper size ('letter' or 'a4'). -# latex_paper_size = 'letter' - -# The font size ('10pt', '11pt' or '12pt'). -# latex_font_size = '10pt' - # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass # [howto/manual]). latex_documents = [ - ('index', 'Zaqar.tex', u'OpenStack Messaging Service API Documentation', + ('index', 'Nova.tex', u'OpenStack Messaging Service API Documentation', u'OpenStack Foundation', 'manual'), ] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# latex_use_parts = False - -# Additional stuff for the LaTeX preamble. -# latex_preamble = '' - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_use_modindex = True diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index 3c3f87399..a0fd1dd16 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -1,21 +1,13 @@ -.. - 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. - :tocdepth: 2 -================================== -Messaging Service API v2 (CURRENT) -================================== +======================== +Messaging Service API v2 +======================== + +This is a reference for the OpenStack Messaging Service API which is provided +by the Zaqar project. + +.. rest_expand_all:: .. include:: versions.inc .. include:: queues.inc