From dcd5e78ec41578d6242280387f3c5b1d69459bca Mon Sep 17 00:00:00 2001 From: Sridhar Ramaswamy Date: Tue, 21 Jun 2016 16:53:06 +0200 Subject: [PATCH] Initial api-ref skeleton for Tacker This patch is the first step to bring the NFV Orchestration API Reference to the repository. It is a part of the effort described here [1]: [1] https://wiki.openstack.org/wiki/Documentation/Migrate#API_Reference_Plan Once this skeleton patch is merged, an api-ref job can be added to the gate. The gate job makes it much easier to review API Reference contents, which will be brought by follow-on patches. Change-Id: I7cc587f2c7b3c546be9cd11bad7e3b4eeacad171 Co-Authored-By: Naoya Harada --- .gitignore | 1 + api-ref/source/conf.py | 230 ++++++++++++++++++++++++++++++ api-ref/source/index.rst | 8 ++ api-ref/source/v1/classifiers.inc | 0 api-ref/source/v1/events.inc | 0 api-ref/source/v1/extensions.inc | 0 api-ref/source/v1/index.rst | 19 +++ api-ref/source/v1/nfps.inc | 0 api-ref/source/v1/parameters.yaml | 0 api-ref/source/v1/sfcs.inc | 0 api-ref/source/v1/status.yaml | 0 api-ref/source/v1/versions.inc | 0 api-ref/source/v1/vims.inc | 0 api-ref/source/v1/vnfds.inc | 0 api-ref/source/v1/vnffgds.inc | 0 api-ref/source/v1/vnffgs.inc | 0 api-ref/source/v1/vnfs.inc | 0 test-requirements.txt | 1 + tox.ini | 8 ++ 19 files changed, 267 insertions(+) create mode 100644 api-ref/source/conf.py create mode 100644 api-ref/source/index.rst create mode 100644 api-ref/source/v1/classifiers.inc create mode 100644 api-ref/source/v1/events.inc create mode 100644 api-ref/source/v1/extensions.inc create mode 100644 api-ref/source/v1/index.rst create mode 100644 api-ref/source/v1/nfps.inc create mode 100644 api-ref/source/v1/parameters.yaml create mode 100644 api-ref/source/v1/sfcs.inc create mode 100644 api-ref/source/v1/status.yaml create mode 100644 api-ref/source/v1/versions.inc create mode 100644 api-ref/source/v1/vims.inc create mode 100644 api-ref/source/v1/vnfds.inc create mode 100644 api-ref/source/v1/vnffgds.inc create mode 100644 api-ref/source/v1/vnffgs.inc create mode 100644 api-ref/source/v1/vnfs.inc diff --git a/.gitignore b/.gitignore index c96b4e300..9b6ed5bf9 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ AUTHORS +api-ref/build/ build/* build-stamp ChangeLog diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py new file mode 100644 index 000000000..79c333cf7 --- /dev/null +++ b/api-ref/source/conf.py @@ -0,0 +1,230 @@ +# -*- coding: utf-8 -*- +# +# 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. +# +# neutron documentation build configuration file, created by +# sphinx-quickstart on Sat May 1 15:17:47 2010. +# +# 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 + +# 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 +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. + +extensions = [ + 'os_api_ref', +] + +html_theme = 'openstackdocs' +html_theme_path = [openstackdocstheme.get_html_theme_path()] +html_theme_options = { + "sidebar_mode": "toc", +} +html_context = {'bug_project': 'tacker', 'bug_tag': 'api-ref'} + +# 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'NFV Orchestration API Reference' +copyright = u'2016-present, 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 tacker.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() + +# 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 + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# -- 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' + +# 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. 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 not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +# html_last_updated_fmt = '%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_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 = 'tackerdoc' + + +# -- 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', 'Tacker.tex', u'OpenStack NFV Orchestration 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 new file mode 100644 index 000000000..62412bec1 --- /dev/null +++ b/api-ref/source/index.rst @@ -0,0 +1,8 @@ +============================== +NFV Orchestration Service APIs +============================== + +.. toctree:: + :maxdepth: 1 + + v1/index diff --git a/api-ref/source/v1/classifiers.inc b/api-ref/source/v1/classifiers.inc new file mode 100644 index 000000000..e69de29bb diff --git a/api-ref/source/v1/events.inc b/api-ref/source/v1/events.inc new file mode 100644 index 000000000..e69de29bb diff --git a/api-ref/source/v1/extensions.inc b/api-ref/source/v1/extensions.inc new file mode 100644 index 000000000..e69de29bb diff --git a/api-ref/source/v1/index.rst b/api-ref/source/v1/index.rst new file mode 100644 index 000000000..6148145fa --- /dev/null +++ b/api-ref/source/v1/index.rst @@ -0,0 +1,19 @@ +:tocdepth: 2 + +########################## +NFV Orchestration API v1.0 +########################## + +.. rest_expand_all:: + +.. include:: versions.inc +.. include:: extensions.inc +.. include:: vnfds.inc +.. include:: vnfs.inc +.. include:: vims.inc +.. include:: events.inc +.. include:: vnffgds.inc +.. include:: vnffgs.inc +.. include:: nfps.inc +.. include:: sfcs.inc +.. include:: classifiers.inc diff --git a/api-ref/source/v1/nfps.inc b/api-ref/source/v1/nfps.inc new file mode 100644 index 000000000..e69de29bb diff --git a/api-ref/source/v1/parameters.yaml b/api-ref/source/v1/parameters.yaml new file mode 100644 index 000000000..e69de29bb diff --git a/api-ref/source/v1/sfcs.inc b/api-ref/source/v1/sfcs.inc new file mode 100644 index 000000000..e69de29bb diff --git a/api-ref/source/v1/status.yaml b/api-ref/source/v1/status.yaml new file mode 100644 index 000000000..e69de29bb diff --git a/api-ref/source/v1/versions.inc b/api-ref/source/v1/versions.inc new file mode 100644 index 000000000..e69de29bb diff --git a/api-ref/source/v1/vims.inc b/api-ref/source/v1/vims.inc new file mode 100644 index 000000000..e69de29bb diff --git a/api-ref/source/v1/vnfds.inc b/api-ref/source/v1/vnfds.inc new file mode 100644 index 000000000..e69de29bb diff --git a/api-ref/source/v1/vnffgds.inc b/api-ref/source/v1/vnffgds.inc new file mode 100644 index 000000000..e69de29bb diff --git a/api-ref/source/v1/vnffgs.inc b/api-ref/source/v1/vnffgs.inc new file mode 100644 index 000000000..e69de29bb diff --git a/api-ref/source/v1/vnfs.inc b/api-ref/source/v1/vnfs.inc new file mode 100644 index 000000000..e69de29bb diff --git a/test-requirements.txt b/test-requirements.txt index 37a6cc0d4..02b31efbd 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -17,6 +17,7 @@ sphinx!=1.3b1,<1.4,>=1.2.1 # BSD oslotest>=1.10.0 # Apache-2.0 os-testr>=0.8.0 # Apache-2.0 tempest>=12.1.0 # Apache-2.0 +os-api-ref>=1.0.0 # Apache-2.0 testrepository>=0.0.18 # Apache-2.0/BSD testtools>=1.4.0 # MIT WebTest>=2.0 # MIT diff --git a/tox.ini b/tox.ini index 40c62f48b..31f14c0cd 100644 --- a/tox.ini +++ b/tox.ini @@ -57,6 +57,14 @@ commands = doc8 -e .rst doc/source/ CONTRIBUTING.rst HACKING.rst README.rst TESTING.rst python setup.py build_sphinx +[testenv:api-ref] +# This environment is called from CI scripts to test and publish +# the API Ref to developer.openstack.org. +commands = + rm -rf api-ref/build + sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html +whitelist_externals = rm + [testenv:releasenotes] commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html