From 6300e730d2c13b337068ee182fd2ae4d52b4fa78 Mon Sep 17 00:00:00 2001 From: Jeremy Liu Date: Thu, 23 Feb 2017 21:14:35 +0800 Subject: [PATCH] Initial commit for Barbican api-ref Change-Id: Ie67aae021efc835d4a1fb5bbfffb8761ea41a3b4 Closes-Bug: #1667053 --- .gitignore | 3 + api-ref/source/acls.inc | 0 api-ref/source/cas.inc | 0 api-ref/source/conf.py | 321 +++++++++++++++++++++++++++++ api-ref/source/consumers.inc | 0 api-ref/source/containers.inc | 0 api-ref/source/index.rst | 16 ++ api-ref/source/orders.inc | 0 api-ref/source/quotas.inc | 0 api-ref/source/secret_metadata.inc | 0 api-ref/source/secrets.inc | 0 api-ref/source/secretstores.inc | 0 api-ref/source/transportkeys.inc | 0 test-requirements.txt | 1 + tox.ini | 9 +- 15 files changed, 349 insertions(+), 1 deletion(-) create mode 100644 api-ref/source/acls.inc create mode 100644 api-ref/source/cas.inc create mode 100644 api-ref/source/conf.py create mode 100644 api-ref/source/consumers.inc create mode 100644 api-ref/source/containers.inc create mode 100644 api-ref/source/index.rst create mode 100644 api-ref/source/orders.inc create mode 100644 api-ref/source/quotas.inc create mode 100644 api-ref/source/secret_metadata.inc create mode 100644 api-ref/source/secrets.inc create mode 100644 api-ref/source/secretstores.inc create mode 100644 api-ref/source/transportkeys.inc diff --git a/.gitignore b/.gitignore index 8e9e02574..4073fc62f 100644 --- a/.gitignore +++ b/.gitignore @@ -70,3 +70,6 @@ ChangeLog # Files created by releasenotes build releasenotes/build + +# Files created by API build +api-ref/build/ diff --git a/api-ref/source/acls.inc b/api-ref/source/acls.inc new file mode 100644 index 000000000..e69de29bb diff --git a/api-ref/source/cas.inc b/api-ref/source/cas.inc new file mode 100644 index 000000000..e69de29bb diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py new file mode 100644 index 000000000..94c3f19dd --- /dev/null +++ b/api-ref/source/conf.py @@ -0,0 +1,321 @@ +# 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. +# +# manila documentation build configuration file, created by +# sphinx-quickstart on Sat May 7 13:35:27 2016. +# +# 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 subprocess +import sys +import warnings + +import openstackdocstheme + +html_theme = 'openstackdocs' +html_theme_path = [openstackdocstheme.get_html_theme_path()] +html_theme_options = { + "sidebar_mode": "toc", +} + +extensions = [ + '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 ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. + +# Add any paths that contain templates here, relative to this directory. +# templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Key Manager API Reference' +copyright = u'OpenStack Foundation' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +from barbican.version import version_info +# The full version, including alpha/beta/rc tags. +release = version_info.release_string() +# The short X.Y version. +version = version_info.version_string() + +html_context = {'bug_project': 'barbican', 'bug_tag': 'api-ref'} + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +# 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 patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = [] + +# 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 + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# html_theme = 'alabaster' + +# 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 = [] + +# The name for this set of Sphinx documents. +# " v documentation" by default. +# html_title = u'Shared File Systems API Reference v2' + +# 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 (relative to this directory) to use as a 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'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# html_extra_path = [] + +# If not None, a 'Last updated on:' timestamp is inserted at every page +# bottom, using the given strftime format. +# The empty string is equivalent to '%b %d, %Y'. +git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local", + "-n1"] +try: + html_last_updated_fmt = subprocess.Popen( + git_cmd, stdout=subprocess.PIPE).communicate()[0] +except Exception: + warnings.warn('Cannot get last updated time from git repository. ' + 'Not setting "html_last_updated_fmt".') + +# 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_domain_indices = 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, "Created using Sphinx" is shown in the HTML footer. Default is True. +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# html_show_copyright = 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 = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh' +# html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# 'ja' uses this config value. +# 'zh' user can custom change `jieba` dictionary path. +# html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +# html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'barbicandoc' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # 'preamble': '', + + # Latex figure (float) alignment + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'barbican.tex', + u'OpenStack Key Manager 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 + +# If true, show page references after internal links. +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'barbican', u'OpenStack Key Manager API Documentation', + u'Openstack Foundation', 1) +] + +# If true, show URL addresses after external links. +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'Barbican', u'OpenStack Key Manager API Documentation', + u'OpenStack Foundation', 'Barbican', 'OpenStack Key Manager', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +# texinfo_appendices = [] + +# If false, no module index is generated. +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# texinfo_no_detailmenu = False diff --git a/api-ref/source/consumers.inc b/api-ref/source/consumers.inc new file mode 100644 index 000000000..e69de29bb diff --git a/api-ref/source/containers.inc b/api-ref/source/containers.inc new file mode 100644 index 000000000..e69de29bb diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst new file mode 100644 index 000000000..147c4ea9e --- /dev/null +++ b/api-ref/source/index.rst @@ -0,0 +1,16 @@ +================================== +OpenStack Key Manager Service APIs +================================== + +.. rest_expand_all:: + +.. include:: acls.inc +.. include:: cas.inc +.. include:: consumers.inc +.. include:: containers.inc +.. include:: orders.inc +.. include:: quotas.inc +.. include:: secret_metadata.inc +.. include:: secrets.inc +.. include:: secretstores.inc +.. include:: transportkeys.inc diff --git a/api-ref/source/orders.inc b/api-ref/source/orders.inc new file mode 100644 index 000000000..e69de29bb diff --git a/api-ref/source/quotas.inc b/api-ref/source/quotas.inc new file mode 100644 index 000000000..e69de29bb diff --git a/api-ref/source/secret_metadata.inc b/api-ref/source/secret_metadata.inc new file mode 100644 index 000000000..e69de29bb diff --git a/api-ref/source/secrets.inc b/api-ref/source/secrets.inc new file mode 100644 index 000000000..e69de29bb diff --git a/api-ref/source/secretstores.inc b/api-ref/source/secretstores.inc new file mode 100644 index 000000000..e69de29bb diff --git a/api-ref/source/transportkeys.inc b/api-ref/source/transportkeys.inc new file mode 100644 index 000000000..e69de29bb diff --git a/test-requirements.txt b/test-requirements.txt index 2504be8ec..4e8572e33 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -25,5 +25,6 @@ bandit>=1.1.0 # Apache-2.0 # Documentation build requirements sphinx>=1.5.1 # BSD oslosphinx>=4.7.0 # Apache-2.0 +os-api-ref>=1.0.0 # Apache-2.0 reno>=1.8.0 # Apache-2.0 openstackdocstheme>=1.5.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index b0a17aa8d..565f75f8c 100644 --- a/tox.ini +++ b/tox.ini @@ -53,9 +53,10 @@ commands = [testenv:docs] commands= - rm -rf api-guide/build + rm -rf doc/build api-guide/build api-ref/build python setup.py build_sphinx sphinx-build -W -b html api-guide/source api-guide/build/html + sphinx-build -W -b html api-ref/source api-ref/build/html whitelist_externals = rm [testenv:api-guide] @@ -64,6 +65,12 @@ whitelist_externals = rm commands = sphinx-build -W -b html -d api-guide/build/doctrees api-guide/source api-guide/build/html +[testenv:api-ref] +# This environment is called from CI scripts to test and publish +# the API Ref to developer.openstack.org. +commands = + sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html + [testenv:functional] # This tox env is purely to make local test development easier # Note: This requires local running instances of Barbican and Keystone