1
# -*- coding: utf-8 -*-
3
# python-libdiscid documentation build configuration file, created by
4
# sphinx-quickstart on Thu Apr 11 14:36:37 2013.
6
# This file is execfile()d with the current directory set to its containing dir.
8
# Note that not all possible configuration values are present in this
11
# All configuration values have a default; values that are commented out
12
# serve to show the default.
16
import distutils.command.build
17
from distutils.dist import Distribution
19
b = distutils.command.build.build(Distribution())
20
b.initialize_options()
23
sys.path.insert(0, os.path.abspath(
24
os.path.join('../../', b.build_lib)))
26
# -- General configuration -----------------------------------------------------
28
# If your documentation needs a minimal Sphinx version, state it here.
31
# Add any Sphinx extension module names here, as strings. They can be extensions
32
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
35
'sphinx.ext.intersphinx',
39
# Add any paths that contain templates here, relative to this directory.
40
templates_path = ['_templates']
42
# The suffix of source filenames.
43
source_suffix = '.rst'
45
# The encoding of source files.
46
#source_encoding = 'utf-8-sig'
48
# The master toctree document.
51
# General information about the project.
52
project = u'python-libdiscid'
53
copyright = u'2013, Sebastian Ramacher'
55
# The version info for the project you're documenting, acts as replacement for
56
# |version| and |release|, also used in various other places throughout the
59
# The short X.Y version.
61
# The full version, including alpha/beta/rc tags.
64
# The language for content autogenerated by Sphinx. Refer to documentation
65
# for a list of supported languages.
68
# There are two options for replacing |today|: either, you set today to some
69
# non-false value, then it is used:
71
# Else, today_fmt is used as the format for a strftime call.
72
#today_fmt = '%B %d, %Y'
74
# List of patterns, relative to source directory, that match files and
75
# directories to ignore when looking for source files.
78
# The reST default role (used for this markup: `text`) to use for all documents.
81
# If true, '()' will be appended to :func: etc. cross-reference text.
82
#add_function_parentheses = True
84
# If true, the current module name will be prepended to all description
85
# unit titles (such as .. function::).
86
#add_module_names = True
88
# If true, sectionauthor and moduleauthor directives will be shown in the
89
# output. They are ignored by default.
92
# The name of the Pygments (syntax highlighting) style to use.
93
pygments_style = 'sphinx'
95
# A list of ignored prefixes for module index sorting.
96
#modindex_common_prefix = []
99
# -- Options for HTML output ---------------------------------------------------
101
# The theme to use for HTML and HTML Help pages. See the documentation for
102
# a list of builtin themes.
103
html_theme = 'default'
105
# Theme options are theme-specific and customize the look and feel of a theme
106
# further. For a list of options available for each theme, see the
108
#html_theme_options = {}
110
# Add any paths that contain custom themes here, relative to this directory.
111
#html_theme_path = []
113
# The name for this set of Sphinx documents. If None, it defaults to
114
# "<project> v<release> documentation".
117
# A shorter title for the navigation bar. Default is the same as html_title.
118
#html_short_title = None
120
# The name of an image file (relative to this directory) to place at the top
124
# The name of an image file (within the static path) to use as favicon of the
125
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
129
# Add any paths that contain custom static files (such as style sheets) here,
130
# relative to this directory. They are copied after the builtin static files,
131
# so a file named "default.css" will overwrite the builtin "default.css".
132
html_static_path = ['_static']
134
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
135
# using the given strftime format.
136
#html_last_updated_fmt = '%b %d, %Y'
138
# If true, SmartyPants will be used to convert quotes and dashes to
139
# typographically correct entities.
140
#html_use_smartypants = True
142
# Custom sidebar templates, maps document names to template names.
145
# Additional templates that should be rendered to pages, maps page names to
147
#html_additional_pages = {}
149
# If false, no module index is generated.
150
#html_domain_indices = True
152
# If false, no index is generated.
153
#html_use_index = True
155
# If true, the index is split into individual pages for each letter.
156
#html_split_index = False
158
# If true, links to the reST sources are added to the pages.
159
#html_show_sourcelink = True
161
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
162
#html_show_sphinx = True
164
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
165
#html_show_copyright = True
167
# If true, an OpenSearch description file will be output, and all pages will
168
# contain a <link> tag referring to it. The value of this option must be the
169
# base URL from which the finished HTML is served.
170
#html_use_opensearch = ''
172
# This is the file name suffix for HTML files (e.g. ".xhtml").
173
#html_file_suffix = None
175
# Output file base name for HTML help builder.
176
htmlhelp_basename = 'python-libdisciddoc'
179
# -- Options for LaTeX output --------------------------------------------------
182
# The paper size ('letterpaper' or 'a4paper').
183
#'papersize': 'letterpaper',
185
# The font size ('10pt', '11pt' or '12pt').
186
#'pointsize': '10pt',
188
# Additional stuff for the LaTeX preamble.
192
# Grouping the document tree into LaTeX files. List of tuples
193
# (source start file, target name, title, author, documentclass [howto/manual]).
195
('index', 'python-libdiscid.tex', u'python-libdiscid Documentation',
196
u'Sebastian Ramacher', 'manual'),
199
# The name of an image file (relative to this directory) to place at the top of
203
# For "manual" documents, if this is true, then toplevel headings are parts,
205
#latex_use_parts = False
207
# If true, show page references after internal links.
208
#latex_show_pagerefs = False
210
# If true, show URL addresses after external links.
211
#latex_show_urls = False
213
# Documents to append as an appendix to all manuals.
214
#latex_appendices = []
216
# If false, no module index is generated.
217
#latex_domain_indices = True
220
# -- Options for manual page output --------------------------------------------
222
# One entry per manual page. List of tuples
223
# (source start file, name, description, authors, manual section).
225
('index', 'python-libdiscid', u'python-libdiscid Documentation',
226
[u'Sebastian Ramacher'], 1)
229
# If true, show URL addresses after external links.
230
#man_show_urls = False
233
# -- Options for Texinfo output ------------------------------------------------
235
# Grouping the document tree into Texinfo files. List of tuples
236
# (source start file, target name, title, author,
237
# dir menu entry, description, category)
238
texinfo_documents = [
239
('index', 'python-libdiscid', u'python-libdiscid Documentation',
240
u'Sebastian Ramacher', 'python-libdiscid', 'One line description of project.',
244
# Documents to append as an appendix to all manuals.
245
#texinfo_appendices = []
247
# If false, no module index is generated.
248
#texinfo_domain_indices = True
250
# How to display URL addresses: 'footnote', 'no', or 'inline'.
251
#texinfo_show_urls = 'footnote'
255
'musicbrainz': ('http://musicbrainz.org/doc/%s', ''),
258
intersphinx_mapping = {
259
'python': ('http://docs.python.org/', None),
260
'pydiscid': ('https://python-discid.readthedocs.org/en/latest/', None),
added
removed
.pc/sphinx-documentation.patch/docs/source/conf.py
