80e1aadc49
Update all .py source files by
$ pyupgrade --py3-only $(git ls-files | grep ".py$")
to modernize the code according to Python 3 syntaxes.
pep8 errors are fixed by
$ autopep8 --select=E127,E128,E501 --max-line-length 79 -r \
--in-place taskflow
Also add the pyupgrade hook to pre-commit to avoid merging additional
Python 2 syntaxes.
Change-Id: Ifd0a0ade9789497482c7937bffd82c48acfb3d78
90 lines
2.8 KiB
Python
90 lines
2.8 KiB
Python
# Copyright (C) 2020 Red Hat, Inc.
|
|
#
|
|
# 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 datetime
|
|
|
|
# -- 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.autodoc',
|
|
'sphinx.ext.doctest',
|
|
'sphinx.ext.extlinks',
|
|
'sphinx.ext.inheritance_diagram',
|
|
'sphinx.ext.viewcode',
|
|
'openstackdocstheme'
|
|
]
|
|
|
|
# openstackdocstheme options
|
|
openstackdocs_repo_name = 'openstack/taskflow'
|
|
openstackdocs_auto_name = False
|
|
openstackdocs_bug_project = 'taskflow'
|
|
openstackdocs_bug_tag = ''
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['templates']
|
|
|
|
# The suffix of source filenames.
|
|
source_suffix = '.rst'
|
|
|
|
# The master toctree document.
|
|
master_doc = 'index'
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
exclude_patterns = ['_build']
|
|
|
|
# General information about the project.
|
|
project = 'TaskFlow'
|
|
copyright = '%s, OpenStack Foundation' % datetime.date.today().year
|
|
|
|
# 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'
|
|
|
|
# Prefixes that are ignored for sorting the Python module index
|
|
modindex_common_prefix = ['taskflow.']
|
|
|
|
# Shortened external links.
|
|
source_tree = 'https://opendev.org/openstack/taskflow/src/branch/master/'
|
|
extlinks = {
|
|
'example': (source_tree + '/taskflow/examples/%s.py', '%s'),
|
|
'pybug': ('http://bugs.python.org/issue%s', '%s'),
|
|
}
|
|
|
|
|
|
# -- 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 = 'openstackdocs'
|
|
|
|
|
|
# -- Options for autoddoc ----------------------------------------------------
|
|
|
|
# Keep source order
|
|
autodoc_member_order = 'bysource'
|
|
|
|
# Always include members
|
|
autodoc_default_options = {'members': None, 'show-inheritance': None}
|