From 73a081355f662bb2e045cfc3cd7a82c7fb4d1e9d Mon Sep 17 00:00:00 2001 From: Mariusz Karpiarz Date: Fri, 9 Dec 2022 16:01:13 +0000 Subject: [PATCH] Move API docs to `api-ref/source` This is the first step towards moving API ref/docs to https://docs.openstack.org/api The `conf.py` file is a copy of the file from `doc/source` and all the other files simply need moving to the new location. Change-Id: I9ecf84b53274d9b86f05800fc9816de275f3e9c5 --- api-ref/source/conf.py | 255 ++++++++++++++++++ .../source}/index.rst | 0 .../source}/v1/rating/hashmap.rst | 0 .../source}/v1/rating/pyscripts.rst | 0 .../source}/v1/v1.rst | 0 .../dataframes/dataframes_get.json | 0 .../dataframes/dataframes_post.json | 0 .../v2/api_samples/rating/module_get.json | 0 .../api_samples/rating/modules_list_get.json | 0 .../v2/api_samples/scope/scope_get.json | 0 .../v2/api_samples/summary/summary_get.json | 0 .../summary/summary_get_groupby_time.json | 0 .../source}/v2/dataframes/dataframes.inc | 0 .../v2/dataframes/dataframes_parameters.yml | 0 .../source}/v2/dataframes/http_status.yml | 0 .../source}/v2/http_status.yml | 0 .../source}/v2/index.rst | 0 .../source}/v2/rating/http_status.yml | 0 .../source}/v2/rating/modules.inc | 0 .../source}/v2/rating/modules_parameters.yml | 0 .../source}/v2/scope/http_status.yml | 0 .../source}/v2/scope/scope.inc | 0 .../source}/v2/scope/scope_parameters.yml | 0 .../source}/v2/summary/summary.inc | 0 .../source}/v2/summary/summary_parameters.yml | 0 .../source}/v2/task/reprocessing.inc | 0 .../v2/task/reprocessing_parameters.yml | 0 doc/source/api-reference | 1 + ...-api-docs-to-api-ref-be71b864e557110e.yaml | 5 + 29 files changed, 261 insertions(+) create mode 100644 api-ref/source/conf.py rename {doc/source/api-reference => api-ref/source}/index.rst (100%) rename {doc/source/api-reference => api-ref/source}/v1/rating/hashmap.rst (100%) rename {doc/source/api-reference => api-ref/source}/v1/rating/pyscripts.rst (100%) rename {doc/source/api-reference => api-ref/source}/v1/v1.rst (100%) rename {doc/source/api-reference => api-ref/source}/v2/api_samples/dataframes/dataframes_get.json (100%) rename {doc/source/api-reference => api-ref/source}/v2/api_samples/dataframes/dataframes_post.json (100%) rename {doc/source/api-reference => api-ref/source}/v2/api_samples/rating/module_get.json (100%) rename {doc/source/api-reference => api-ref/source}/v2/api_samples/rating/modules_list_get.json (100%) rename {doc/source/api-reference => api-ref/source}/v2/api_samples/scope/scope_get.json (100%) rename {doc/source/api-reference => api-ref/source}/v2/api_samples/summary/summary_get.json (100%) rename {doc/source/api-reference => api-ref/source}/v2/api_samples/summary/summary_get_groupby_time.json (100%) rename {doc/source/api-reference => api-ref/source}/v2/dataframes/dataframes.inc (100%) rename {doc/source/api-reference => api-ref/source}/v2/dataframes/dataframes_parameters.yml (100%) rename {doc/source/api-reference => api-ref/source}/v2/dataframes/http_status.yml (100%) rename {doc/source/api-reference => api-ref/source}/v2/http_status.yml (100%) rename {doc/source/api-reference => api-ref/source}/v2/index.rst (100%) rename {doc/source/api-reference => api-ref/source}/v2/rating/http_status.yml (100%) rename {doc/source/api-reference => api-ref/source}/v2/rating/modules.inc (100%) rename {doc/source/api-reference => api-ref/source}/v2/rating/modules_parameters.yml (100%) rename {doc/source/api-reference => api-ref/source}/v2/scope/http_status.yml (100%) rename {doc/source/api-reference => api-ref/source}/v2/scope/scope.inc (100%) rename {doc/source/api-reference => api-ref/source}/v2/scope/scope_parameters.yml (100%) rename {doc/source/api-reference => api-ref/source}/v2/summary/summary.inc (100%) rename {doc/source/api-reference => api-ref/source}/v2/summary/summary_parameters.yml (100%) rename {doc/source/api-reference => api-ref/source}/v2/task/reprocessing.inc (100%) rename {doc/source/api-reference => api-ref/source}/v2/task/reprocessing_parameters.yml (100%) create mode 120000 doc/source/api-reference create mode 100644 releasenotes/notes/move-api-docs-to-api-ref-be71b864e557110e.yaml diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py new file mode 100644 index 00000000..293cda3c --- /dev/null +++ b/api-ref/source/conf.py @@ -0,0 +1,255 @@ +# Copyright (c) 2010 OpenStack Foundation. +# +# 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 execfile()'d with the current directory set to its containing +# dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import os +import sys + + +# 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 = [ + os.path.abspath('../..'), + os.path.abspath('../../bin') +] + sys.path + +# -- 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. +extensions = ['sphinx.ext.coverage', + 'sphinx.ext.ifconfig', + 'sphinx.ext.graphviz', + 'stevedore.sphinxext', + 'oslo_config.sphinxext', + 'sphinx.ext.viewcode', + 'oslo_config.sphinxconfiggen', + 'sphinx.ext.mathjax', + 'wsmeext.sphinxext', + 'sphinx.ext.autodoc', + 'sphinxcontrib.pecanwsme.rest', + 'sphinxcontrib.httpdomain', + 'os_api_ref', + 'openstackdocstheme', + 'oslo_policy.sphinxext', + 'oslo_policy.sphinxpolicygen', + ] + +# Ignore the following warning: WARNING: while setting up extension +# wsmeext.sphinxext: directive 'autoattribute' is already registered, +# it will be overridden. +suppress_warnings = ['app.add_directive'] + +# openstackdocstheme options +openstackdocs_repo_name = 'openstack/cloudkitty' +openstackdocs_pdf_link = True +openstackdocs_use_storyboard = True + +config_generator_config_file = '../../etc/oslo-config-generator/cloudkitty.conf' +policy_generator_config_file = '../../etc/oslo-policy-generator/cloudkitty.conf' +sample_policy_basename = sample_config_basename = '_static/cloudkitty' + +# Add any paths that contain templates here, relative to this directory. +# templates_path = [] + +# 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 = '2014-present, OpenStack Foundation.' + +# 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' + +# List of documents that shouldn't be included in the build. +#unused_docs = [] + +# List of directories, relative to source directory, that shouldn't be searched +# for source files. +#exclude_trees = ['api'] +exclude_patterns = [] + +# The reST default role (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 = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +show_authors = True + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'native' + +# A list of ignored prefixes for module index sorting. +modindex_common_prefix = ['cloudkitty.'] + +# -- Options for man page output -------------------------------------------- + +# Grouping the document tree for man pages. +# List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual' + +man_pages = [ + ('index', 'cloudkitty', 'cloudkitty Documentation', + ['Objectif Libre'], 1) +] + +# -- 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 = '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 +# documentation. +html_theme_options = { + "show_other_versions": "True", +} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = ['_theme'] +#html_theme_path = [openstackdocstheme.get_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 = 'cloudkittydoc' + + +# -- 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 = [ + ('pdf-index', 'doc-cloudkitty.tex', 'Cloudkitty Documentation', + 'Cloudkitty Team', '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 + +# If false, no module index is generated. +latex_domain_indices = False + +latex_elements = { + 'makeindex': '', + 'printindex': '', + 'preamble': r'\setcounter{tocdepth}{3}', +} + +# Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664 +latex_use_xindy = False diff --git a/doc/source/api-reference/index.rst b/api-ref/source/index.rst similarity index 100% rename from doc/source/api-reference/index.rst rename to api-ref/source/index.rst diff --git a/doc/source/api-reference/v1/rating/hashmap.rst b/api-ref/source/v1/rating/hashmap.rst similarity index 100% rename from doc/source/api-reference/v1/rating/hashmap.rst rename to api-ref/source/v1/rating/hashmap.rst diff --git a/doc/source/api-reference/v1/rating/pyscripts.rst b/api-ref/source/v1/rating/pyscripts.rst similarity index 100% rename from doc/source/api-reference/v1/rating/pyscripts.rst rename to api-ref/source/v1/rating/pyscripts.rst diff --git a/doc/source/api-reference/v1/v1.rst b/api-ref/source/v1/v1.rst similarity index 100% rename from doc/source/api-reference/v1/v1.rst rename to api-ref/source/v1/v1.rst diff --git a/doc/source/api-reference/v2/api_samples/dataframes/dataframes_get.json b/api-ref/source/v2/api_samples/dataframes/dataframes_get.json similarity index 100% rename from doc/source/api-reference/v2/api_samples/dataframes/dataframes_get.json rename to api-ref/source/v2/api_samples/dataframes/dataframes_get.json diff --git a/doc/source/api-reference/v2/api_samples/dataframes/dataframes_post.json b/api-ref/source/v2/api_samples/dataframes/dataframes_post.json similarity index 100% rename from doc/source/api-reference/v2/api_samples/dataframes/dataframes_post.json rename to api-ref/source/v2/api_samples/dataframes/dataframes_post.json diff --git a/doc/source/api-reference/v2/api_samples/rating/module_get.json b/api-ref/source/v2/api_samples/rating/module_get.json similarity index 100% rename from doc/source/api-reference/v2/api_samples/rating/module_get.json rename to api-ref/source/v2/api_samples/rating/module_get.json diff --git a/doc/source/api-reference/v2/api_samples/rating/modules_list_get.json b/api-ref/source/v2/api_samples/rating/modules_list_get.json similarity index 100% rename from doc/source/api-reference/v2/api_samples/rating/modules_list_get.json rename to api-ref/source/v2/api_samples/rating/modules_list_get.json diff --git a/doc/source/api-reference/v2/api_samples/scope/scope_get.json b/api-ref/source/v2/api_samples/scope/scope_get.json similarity index 100% rename from doc/source/api-reference/v2/api_samples/scope/scope_get.json rename to api-ref/source/v2/api_samples/scope/scope_get.json diff --git a/doc/source/api-reference/v2/api_samples/summary/summary_get.json b/api-ref/source/v2/api_samples/summary/summary_get.json similarity index 100% rename from doc/source/api-reference/v2/api_samples/summary/summary_get.json rename to api-ref/source/v2/api_samples/summary/summary_get.json diff --git a/doc/source/api-reference/v2/api_samples/summary/summary_get_groupby_time.json b/api-ref/source/v2/api_samples/summary/summary_get_groupby_time.json similarity index 100% rename from doc/source/api-reference/v2/api_samples/summary/summary_get_groupby_time.json rename to api-ref/source/v2/api_samples/summary/summary_get_groupby_time.json diff --git a/doc/source/api-reference/v2/dataframes/dataframes.inc b/api-ref/source/v2/dataframes/dataframes.inc similarity index 100% rename from doc/source/api-reference/v2/dataframes/dataframes.inc rename to api-ref/source/v2/dataframes/dataframes.inc diff --git a/doc/source/api-reference/v2/dataframes/dataframes_parameters.yml b/api-ref/source/v2/dataframes/dataframes_parameters.yml similarity index 100% rename from doc/source/api-reference/v2/dataframes/dataframes_parameters.yml rename to api-ref/source/v2/dataframes/dataframes_parameters.yml diff --git a/doc/source/api-reference/v2/dataframes/http_status.yml b/api-ref/source/v2/dataframes/http_status.yml similarity index 100% rename from doc/source/api-reference/v2/dataframes/http_status.yml rename to api-ref/source/v2/dataframes/http_status.yml diff --git a/doc/source/api-reference/v2/http_status.yml b/api-ref/source/v2/http_status.yml similarity index 100% rename from doc/source/api-reference/v2/http_status.yml rename to api-ref/source/v2/http_status.yml diff --git a/doc/source/api-reference/v2/index.rst b/api-ref/source/v2/index.rst similarity index 100% rename from doc/source/api-reference/v2/index.rst rename to api-ref/source/v2/index.rst diff --git a/doc/source/api-reference/v2/rating/http_status.yml b/api-ref/source/v2/rating/http_status.yml similarity index 100% rename from doc/source/api-reference/v2/rating/http_status.yml rename to api-ref/source/v2/rating/http_status.yml diff --git a/doc/source/api-reference/v2/rating/modules.inc b/api-ref/source/v2/rating/modules.inc similarity index 100% rename from doc/source/api-reference/v2/rating/modules.inc rename to api-ref/source/v2/rating/modules.inc diff --git a/doc/source/api-reference/v2/rating/modules_parameters.yml b/api-ref/source/v2/rating/modules_parameters.yml similarity index 100% rename from doc/source/api-reference/v2/rating/modules_parameters.yml rename to api-ref/source/v2/rating/modules_parameters.yml diff --git a/doc/source/api-reference/v2/scope/http_status.yml b/api-ref/source/v2/scope/http_status.yml similarity index 100% rename from doc/source/api-reference/v2/scope/http_status.yml rename to api-ref/source/v2/scope/http_status.yml diff --git a/doc/source/api-reference/v2/scope/scope.inc b/api-ref/source/v2/scope/scope.inc similarity index 100% rename from doc/source/api-reference/v2/scope/scope.inc rename to api-ref/source/v2/scope/scope.inc diff --git a/doc/source/api-reference/v2/scope/scope_parameters.yml b/api-ref/source/v2/scope/scope_parameters.yml similarity index 100% rename from doc/source/api-reference/v2/scope/scope_parameters.yml rename to api-ref/source/v2/scope/scope_parameters.yml diff --git a/doc/source/api-reference/v2/summary/summary.inc b/api-ref/source/v2/summary/summary.inc similarity index 100% rename from doc/source/api-reference/v2/summary/summary.inc rename to api-ref/source/v2/summary/summary.inc diff --git a/doc/source/api-reference/v2/summary/summary_parameters.yml b/api-ref/source/v2/summary/summary_parameters.yml similarity index 100% rename from doc/source/api-reference/v2/summary/summary_parameters.yml rename to api-ref/source/v2/summary/summary_parameters.yml diff --git a/doc/source/api-reference/v2/task/reprocessing.inc b/api-ref/source/v2/task/reprocessing.inc similarity index 100% rename from doc/source/api-reference/v2/task/reprocessing.inc rename to api-ref/source/v2/task/reprocessing.inc diff --git a/doc/source/api-reference/v2/task/reprocessing_parameters.yml b/api-ref/source/v2/task/reprocessing_parameters.yml similarity index 100% rename from doc/source/api-reference/v2/task/reprocessing_parameters.yml rename to api-ref/source/v2/task/reprocessing_parameters.yml diff --git a/doc/source/api-reference b/doc/source/api-reference new file mode 120000 index 00000000..6f3d56db --- /dev/null +++ b/doc/source/api-reference @@ -0,0 +1 @@ +../../api-ref/source \ No newline at end of file diff --git a/releasenotes/notes/move-api-docs-to-api-ref-be71b864e557110e.yaml b/releasenotes/notes/move-api-docs-to-api-ref-be71b864e557110e.yaml new file mode 100644 index 00000000..def8c76c --- /dev/null +++ b/releasenotes/notes/move-api-docs-to-api-ref-be71b864e557110e.yaml @@ -0,0 +1,5 @@ +--- +other: + - | + API reference/docs have been moved to `api-ref/source/` and the original + path now contains a symlink to this directory.