Skip to content

Commit bda535e

Browse files
committed
doc: Remove cruft from conf.py
Change-Id: I0c0c77c25d3c96dd3c6a2a01be4f196c02e71dd6
1 parent b95a20d commit bda535e

1 file changed

Lines changed: 6 additions & 136 deletions

File tree

‎doc/source/conf.py‎

Lines changed: 6 additions & 136 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# -*- coding: utf-8 -*-
2-
31
# Licensed under the Apache License, Version 2.0 (the "License"); you may
42
# not use this file except in compliance with the License. You may obtain
53
# a copy of the License at
@@ -12,16 +10,7 @@
1210
# License for the specific language governing permissions and limitations
1311
# under the License.
1412

15-
# python-cinderclient documentation build configuration file, created by
16-
# sphinx-quickstart on Sun Dec 6 14:19:25 2009.
17-
#
18-
# This file is execfile()d with current directory set to its containing dir.
19-
#
20-
# Note that not all possible configuration values are present in this
21-
# autogenerated file.
22-
#
23-
# All configuration values have a default; values that are commented out
24-
# serve to show the default.
13+
# python-cinderclient documentation build configuration file
2514

2615
import os
2716
import sys
@@ -53,9 +42,6 @@
5342
# The suffix of source filenames.
5443
source_suffix = '.rst'
5544

56-
# The encoding of source files.
57-
# source_encoding = 'utf-8'
58-
5945
# The master toctree document.
6046
master_doc = 'index'
6147

@@ -72,157 +58,41 @@
7258
# The full version, including alpha/beta/rc tags.
7359
release = version_info.release_string()
7460

75-
# The language for content autogenerated by Sphinx. Refer to documentation
76-
# for a list of supported languages.
77-
# language = None
78-
79-
# There are two options for replacing |today|: either, you set today to some
80-
# non-false value, then it is used:
81-
# today = ''
82-
# Else, today_fmt is used as the format for a strftime call.
83-
# today_fmt = '%B %d, %Y'
84-
85-
# List of documents that shouldn't be included in the build.
86-
# unused_docs = []
87-
8861
# List of directories, relative to source directory, that shouldn't be searched
8962
# for source files.
9063
exclude_trees = []
9164

92-
# The reST default role (used for this markup: `text`) to use for all
93-
# documents.
94-
# default_role = None
95-
9665
# If true, '()' will be appended to :func: etc. cross-reference text.
9766
add_function_parentheses = True
9867

9968
# If true, the current module name will be prepended to all description
10069
# unit titles (such as .. function::).
10170
add_module_names = True
10271

103-
# If true, sectionauthor and moduleauthor directives will be shown in the
104-
# output. They are ignored by default.
105-
# show_authors = False
106-
10772
# The name of the Pygments (syntax highlighting) style to use.
10873
pygments_style = 'sphinx'
10974

110-
# A list of ignored prefixes for module index sorting.
111-
# modindex_common_prefix = []
112-
113-
114-
man_pages = [
115-
('cli/details', 'cinder', u'Client for OpenStack Block Storage API',
116-
[u'OpenStack Contributors'], 1),
117-
]
11875
# -- Options for HTML output --------------------------------------------------
11976

12077
# The theme to use for HTML and HTML Help pages. Major themes that come with
12178
# Sphinx are currently 'default' and 'sphinxdoc'.
12279
# html_theme = 'nature'
12380
html_theme = 'openstackdocs'
12481

125-
# Theme options are theme-specific and customize the look and feel of a theme
126-
# further. For a list of options available for each theme, see the
127-
# documentation.
128-
# html_theme_options = {}
129-
130-
# Add any paths that contain custom themes here, relative to this directory.
131-
# html_theme_path = []
132-
133-
# The name for this set of Sphinx documents. If None, it defaults to
134-
# "<project> v<release> documentation".
135-
# html_title = None
136-
137-
# A shorter title for the navigation bar. Default is the same as html_title.
138-
# html_short_title = None
139-
140-
# The name of an image file (relative to this directory) to place at the top
141-
# of the sidebar.
142-
# html_logo = None
143-
144-
# The name of an image file (within the static path) to use as favicon of the
145-
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
146-
# pixels large.
147-
# html_favicon = None
148-
149-
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
150-
# using the given strftime format.
151-
# html_last_updated_fmt = '%b %d, %Y'
152-
153-
# If true, SmartyPants will be used to convert quotes and dashes to
154-
# typographically correct entities.
155-
# html_use_smartypants = True
156-
157-
# Custom sidebar templates, maps document names to template names.
158-
# html_sidebars = {}
159-
160-
# Additional templates that should be rendered to pages, maps page names to
161-
# template names.
162-
# html_additional_pages = {}
163-
164-
# If false, no module index is generated.
165-
# html_use_modindex = True
166-
167-
# If false, no index is generated.
168-
# html_use_index = True
169-
170-
# If true, the index is split into individual pages for each letter.
171-
# html_split_index = False
172-
173-
# If true, links to the reST sources are added to the pages.
174-
# html_show_sourcelink = True
175-
176-
# If true, an OpenSearch description file will be output, and all pages will
177-
# contain a <link> tag referring to it. The value of this option must be the
178-
# base URL from which the finished HTML is served.
179-
# html_use_opensearch = ''
180-
181-
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
182-
# html_file_suffix = ''
183-
184-
# Output file base name for HTML help builder.
185-
htmlhelp_basename = 'python-cinderclientdoc'
186-
18782
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
18883
# using the given strftime format.
18984
# html_last_updated_fmt = '%b %d, %Y'
19085
html_last_updated_fmt = '%Y-%m-%d %H:%M'
19186

192-
# -- Options for LaTeX output -------------------------------------------------
87+
# -- Options for manual page output ------------------------------------------
19388

194-
# The paper size ('letter' or 'a4').
195-
# latex_paper_size = 'letter'
196-
197-
# The font size ('10pt', '11pt' or '12pt').
198-
# latex_font_size = '10pt'
199-
200-
# Grouping the document tree into LaTeX files. List of tuples
201-
# (source start file, target name, title, author, documentclass [howto/manual])
202-
# .
203-
latex_documents = [
204-
('index', 'python-cinderclient.tex', 'python-cinderclient Documentation',
205-
'Rackspace - based on work by Jacob Kaplan-Moss', 'manual'),
89+
man_pages = [
90+
('cli/details', 'cinder', u'Client for OpenStack Block Storage API',
91+
[u'OpenStack Contributors'], 1),
20692
]
20793

208-
# The name of an image file (relative to this directory) to place at the top of
209-
# the title page.
210-
# latex_logo = None
211-
212-
# For "manual" documents, if this is true, then toplevel headings are parts,
213-
# not chapters.
214-
# latex_use_parts = False
215-
216-
# Additional stuff for the LaTeX preamble.
217-
# latex_preamble = ''
218-
219-
# Documents to append as an appendix to all manuals.
220-
# latex_appendices = []
221-
222-
# If false, no module index is generated.
223-
# latex_use_modindex = True
224-
22594
# -- Options for openstackdocstheme -------------------------------------------
95+
22696
repository_name = 'openstack/python-cinderclient'
22797
bug_project = 'cinderclient'
22898
bug_tag = ''

0 commit comments

Comments
 (0)