63da3ebb54
- rearrange docs and add doc/requirements.txt - add releasenotes directory and reno setup files - update some requirements - add lower-constraints - update tox.ini - minor changes for doc8 and pep8 - add .zuul.yaml Technical debt: the tox 'pylint' testenv doesn't work; see comments in tox.ini Change-Id: I35e4dc1b9af91741176784886a84c55fbd4cd11c
154 lines
4.7 KiB
Python
Executable File
154 lines
4.7 KiB
Python
Executable File
# 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 pbr.version
|
|
|
|
# -- 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.
|
|
extensions = ['sphinx.ext.autodoc',
|
|
'sphinx.ext.viewcode',
|
|
'reno.sphinxext',
|
|
'pbr.sphinxext',
|
|
'openstackdocstheme']
|
|
|
|
# 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 master toctree document.
|
|
master_doc = 'index'
|
|
|
|
# General information about the project.
|
|
project = u'rbd-iscsi-client'
|
|
copyright = u"2019, Walter A. Boring IV"
|
|
author = u"Cinder Contributors"
|
|
|
|
# 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.
|
|
#
|
|
# The short X.Y version.
|
|
version_info = pbr.version.VersionInfo('rbd-iscsi-client')
|
|
version = version_info.version_string()
|
|
release = version_info.release_string()
|
|
|
|
# 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
|
|
|
|
add_function_parentheses = True
|
|
add_module_names = False
|
|
|
|
# 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 = ['_build', 'Thumbs.db', '.DS_Store']
|
|
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
|
pygments_style = 'native'
|
|
|
|
# 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 = 'openstackdocs'
|
|
|
|
html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
|
|
|
|
|
# -- Options for HTMLHelp output ---------------------------------------
|
|
|
|
# Output file base name for HTML help builder.
|
|
htmlhelp_basename = 'rbd_iscsi_clientdoc'
|
|
|
|
|
|
# -- 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, 'rbd_iscsi_client.tex',
|
|
u'RBD iSCSI Client Documentation',
|
|
author, 'manual'),
|
|
]
|
|
|
|
|
|
# -- 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, 'rbd_iscsi_client',
|
|
u'RBD iSCSI Client Documentation',
|
|
[author], 1)
|
|
]
|
|
|
|
|
|
# -- 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, 'rbd_iscsi_client',
|
|
u'RBD iSCSI Client Documentation',
|
|
author,
|
|
'rbd_iscsi_client',
|
|
"Provides a REST client that talks to ceph-isci's rbd-target-api "
|
|
"to export rbd images/volumes to an iSCSI initiator.",
|
|
'Miscellaneous'),
|
|
]
|
|
|
|
|
|
# -- Options for openstackdocstheme -----------------------------------
|
|
openstackdocs_repo_name = 'openstack/rbd-iscsi-client'
|
|
openstackdocs_bug_project = 'rbd-iscsi-client'
|
|
openstackdocs_bug_tag = 'doc'
|