summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorStephen Finucane <sfinucan@redhat.com>2017-04-19 10:01:33 +0100
committerStephen Finucane <sfinucan@redhat.com>2017-08-22 11:44:35 +0100
commitbda535e15d724579b54607168549666090572ec3 (patch)
tree4fb680bbb9ab84fc4794d42dc94f490f8caeb452 /doc
parentb95a20d0059a756cb863a4d24e2b3b026c671e07 (diff)
downloadpython-cinderclient-bda535e15d724579b54607168549666090572ec3.tar.gz
doc: Remove cruft from conf.py
Change-Id: I0c0c77c25d3c96dd3c6a2a01be4f196c02e71dd6
Diffstat (limited to 'doc')
-rw-r--r--doc/source/conf.py142
1 files changed, 6 insertions, 136 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 0af2671..81acc28 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -1,5 +1,3 @@
-# -*- 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
@@ -12,16 +10,7 @@
# License for the specific language governing permissions and limitations
# under the License.
-# python-cinderclient documentation build configuration file, created by
-# sphinx-quickstart on Sun Dec 6 14:19:25 2009.
-#
-# This file is execfile()d with 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.
+# python-cinderclient documentation build configuration file
import os
import sys
@@ -53,9 +42,6 @@ templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
-# The encoding of source files.
-# source_encoding = 'utf-8'
-
# The master toctree document.
master_doc = 'index'
@@ -72,27 +58,10 @@ version = version_info.version_string()
# The full version, including alpha/beta/rc tags.
release = version_info.release_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'
-
-# List of documents that shouldn't be included in the build.
-# unused_docs = []
-
# List of directories, relative to source directory, that shouldn't be searched
# for source files.
exclude_trees = []
-# 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
@@ -100,21 +69,9 @@ add_function_parentheses = True
# unit titles (such as .. function::).
add_module_names = True
-# 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'
-# A list of ignored prefixes for module index sorting.
-# modindex_common_prefix = []
-
-
-man_pages = [
- ('cli/details', 'cinder', u'Client for OpenStack Block Storage API',
- [u'OpenStack Contributors'], 1),
-]
# -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. Major themes that come with
@@ -122,107 +79,20 @@ man_pages = [
# html_theme = 'nature'
html_theme = 'openstackdocs'
-# 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
-# "<project> v<release> 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
-
-# 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'
-
-# 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 <link> 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 = 'python-cinderclientdoc'
-
# 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'
html_last_updated_fmt = '%Y-%m-%d %H:%M'
-# -- Options for LaTeX output -------------------------------------------------
+# -- Options for manual page 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', 'python-cinderclient.tex', 'python-cinderclient Documentation',
- 'Rackspace - based on work by Jacob Kaplan-Moss', 'manual'),
+man_pages = [
+ ('cli/details', 'cinder', u'Client for OpenStack Block Storage API',
+ [u'OpenStack Contributors'], 1),
]
-# 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
-
# -- Options for openstackdocstheme -------------------------------------------
+
repository_name = 'openstack/python-cinderclient'
bug_project = 'cinderclient'
bug_tag = ''