ccb8dadb55
This patch removes documentation for the following legacy features. - Extensions - Virtualized Network Function Descriptors (VNFDs) - Virtualized Network Functions (VNFs) - Events - VNF Forwarding Graph Descriptors (VNFFGDs) - VNF Forwarding Graphs (VNFFGs) - Network Forwarding Paths (NFPs) - Service Function Chains (SFCs) - Classifiers - Network Service Descriptors (NSD) - Network Services (NSs) And also remove the following tools that are currently not in use. - tools/vnfc/build_image.sh - tools/check_i18n_test_case.txt - tools/check_i18n.py - tools/i18n_cfg.py - tools/clean.sh - tools/prepare_function_test.sh - tools/test-setup.sh - tools/install_venv_common.py - tools/install_venv.py - tools/with_venv.sh For the following tools used in FT, move them under `tacker/tests/functional/tools`. - tools/test-setup-default-vim.sh - tools/test-setup-k8s-vim.sh - tools/test-setup-mgmt.sh - tools/test-setup-fake-prometheus-server.sh Implements: blueprint deprecate-legacy-apis Change-Id: Iea89c32f69ccbe47badcfddcf77430abda98362b
109 lines
3.4 KiB
Python
109 lines
3.4 KiB
Python
# 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.
|
|
|
|
import os
|
|
import sys
|
|
|
|
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 = [
|
|
'sphinxcontrib.apidoc',
|
|
'stevedore.sphinxext',
|
|
'openstackdocstheme',
|
|
'oslo_config.sphinxext',
|
|
'oslo_config.sphinxconfiggen',
|
|
'oslo_policy.sphinxext',
|
|
'oslo_policy.sphinxpolicygen',
|
|
]
|
|
|
|
config_generator_config_file = '../../etc/config-generator.conf'
|
|
sample_config_basename = '_static/tacker'
|
|
|
|
policy_generator_config_file = [
|
|
('../../etc/tacker-policy-generator.conf', '_static/tacker'),
|
|
]
|
|
sample_policy_basename = '_static/tacker'
|
|
|
|
# sphinxcontrib.apidoc options
|
|
apidoc_module_dir = '../../tacker'
|
|
apidoc_output_dir = 'contributor/api'
|
|
apidoc_excluded_paths = [
|
|
'tests/*',
|
|
'tests',
|
|
'nfvo/workflows/*',
|
|
'nfvo/workflows',
|
|
'vnfm/workflows/*',
|
|
'vnfm/workflows',
|
|
'db/migration/alembic_migrations/*',
|
|
'db/migration/alembic_migrations',
|
|
# TODO(ueha): Excluding 'db/types.py' will be removed after the issue of
|
|
# TypeDecorator is fixed.
|
|
'db/types.py',
|
|
'hacking']
|
|
apidoc_separate_modules = True
|
|
|
|
# The suffix of source filenames.
|
|
source_suffix = '.rst'
|
|
|
|
# The master toctree document.
|
|
master_doc = 'index'
|
|
|
|
# General information about the project.
|
|
project = 'tacker'
|
|
copyright = '2013, OpenStack Foundation'
|
|
|
|
# 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
|
|
|
|
# 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 = ['tacker.']
|
|
|
|
# -- 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_static_path = ['static']
|
|
html_theme = 'openstackdocs'
|
|
|
|
# Output file base name for HTML help builder.
|
|
htmlhelp_basename = '%sdoc' % project
|
|
|
|
# Grouping the document tree into LaTeX files. List of tuples
|
|
# (source start file, target name, title, author, documentclass
|
|
# [howto/manual]).
|
|
latex_documents = [
|
|
('index',
|
|
'%s.tex' % project,
|
|
'%s Documentation' % project,
|
|
'OpenStack Foundation', 'manual'),
|
|
]
|
|
|
|
# Example configuration for intersphinx: refer to the Python standard library.
|
|
#intersphinx_mapping = {'http://docs.python.org/': None}
|
|
|
|
# -- Options for openstackdocstheme -------------------------------------------
|
|
openstackdocs_repo_name = 'openstack/tacker'
|
|
openstackdocs_auto_name = False
|
|
openstackdocs_bug_project = 'tacker'
|
|
openstackdocs_bug_tag = ''
|