blob: a5d87bb98ce36844e1f31155e532260ab96a7a3b [file] [log] [blame]
Chandan Kumar5e619872017-09-07 22:23:55 +05301# -*- coding: utf-8 -*-
2# Licensed under the Apache License, Version 2.0 (the "License");
3# you may not use this file except in compliance with the License.
4# You may obtain a copy of the License at
5#
6# http://www.apache.org/licenses/LICENSE-2.0
7#
8# Unless required by applicable law or agreed to in writing, software
9# distributed under the License is distributed on an "AS IS" BASIS,
10# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
11# implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14
15import os
16import sys
17
Elod Illesf2e985e2023-11-06 19:30:29 +010018def autodoc_skip_member_handler(app, what, name, obj, skip, options):
Frode Nordahl1bb8e622023-10-16 15:16:34 +020019 return skip or (
20 (what == "class" and not name.startswith("test")) or
21 # NOTE(fnordahl): Sphinx does not like the ASCII art in the docstring.
22 (what == 'module' and name == 'NetworkMultipleGWTest'))
Elod Illesf2e985e2023-11-06 19:30:29 +010023
24def setup(app):
25 app.connect('autodoc-skip-member', autodoc_skip_member_handler)
26
27sys.path.insert(0, os.path.abspath('../../neutron_tempest_plugin'))
28
Chandan Kumar5e619872017-09-07 22:23:55 +053029# -- General configuration ----------------------------------------------------
30
31# Add any Sphinx extension module names here, as strings. They can be
32# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
33extensions = [
34 'sphinx.ext.autodoc',
35 'openstackdocstheme',
Chandan Kumar5e619872017-09-07 22:23:55 +053036]
37
38# autodoc generation is a bit aggressive and a nuisance when doing heavy
39# text edit cycles.
40# execute "export SPHINX_DEBUG=1" in your terminal to disable
41
42# The suffix of source filenames.
43source_suffix = '.rst'
44
45# The master toctree document.
46master_doc = 'index'
47
48# General information about the project.
LiZekun8ad510e2022-06-06 19:36:41 +080049copyright = '2017, OpenStack Developers'
Chandan Kumar5e619872017-09-07 22:23:55 +053050
51# openstackdocstheme options
Andreas Jaeger7dc28572020-05-31 20:10:42 +020052openstackdocs_repo_name = 'openstack/neutron-tempest-plugin'
53openstackdocs_bug_project = 'neutron_tempest_plugin'
54openstackdocs_bug_tag = ''
Chandan Kumar5e619872017-09-07 22:23:55 +053055
56# If true, '()' will be appended to :func: etc. cross-reference text.
57add_function_parentheses = True
58
59# If true, the current module name will be prepended to all description
60# unit titles (such as .. function::).
61add_module_names = True
62
63# The name of the Pygments (syntax highlighting) style to use.
Andreas Jaeger7dc28572020-05-31 20:10:42 +020064pygments_style = 'native'
Chandan Kumar5e619872017-09-07 22:23:55 +053065
66# -- Options for HTML output --------------------------------------------------
67
68# The theme to use for HTML and HTML Help pages. Major themes that come with
69# Sphinx are currently 'default' and 'sphinxdoc'.
70# html_theme_path = ["."]
71# html_theme = '_theme'
72# html_static_path = ['static']
73html_theme = 'openstackdocs'
74
75# Output file base name for HTML help builder.
pengyuesheng88ff7432019-07-26 11:34:05 +080076htmlhelp_basename = 'openstackdoc'
Chandan Kumar5e619872017-09-07 22:23:55 +053077
78# Grouping the document tree into LaTeX files. List of tuples
79# (source start file, target name, title, author, documentclass
80# [howto/manual]).
81latex_documents = [
82 ('index',
pengyuesheng88ff7432019-07-26 11:34:05 +080083 'openstack.tex',
LiZekun8ad510e2022-06-06 19:36:41 +080084 'openstack Documentation',
85 'OpenStack Developers', 'manual'),
Chandan Kumar5e619872017-09-07 22:23:55 +053086]
87
88# Example configuration for intersphinx: refer to the Python standard library.
89#intersphinx_mapping = {'http://docs.python.org/': None}