1
# -*- coding: utf-8 -*-
3
# PyZMQ documentation build configuration file, created by
4
# sphinx-quickstart on Sat Feb 20 23:31:19 2010.
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.
17
# If extensions (or modules to document with autodoc) are in another directory,
18
# add these directories to sys.path here. If the directory is relative to the
19
# documentation root, use os.path.abspath to make it absolute, like shown here.
20
sys.path.insert(0,os.path.abspath('../sphinxext'))
22
# patch autodoc to work with Cython Sources
25
# -- General configuration -----------------------------------------------------
27
# Add any Sphinx extension module names here, as strings. They can be extensions
28
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
29
extensions = ['matplotlib.sphinxext.mathmpl',
30
'matplotlib.sphinxext.only_directives',
31
'matplotlib.sphinxext.plot_directive',
34
'sphinx.ext.intersphinx',
35
'ipython_console_highlighting',
38
# Add any paths that contain templates here, relative to this directory.
39
templates_path = ['_templates']
41
# The suffix of source filenames.
42
source_suffix = '.rst'
44
# The encoding of source files.
45
source_encoding = 'utf-8'
47
# The master toctree document.
50
# General information about the project.
52
copyright = u"""2010-2011, Brian E. Granger & Min Ragan-Kelley.
53
ØMQ logo © iMatix Corportation, used under the Creative Commons Attribution-Share Alike 3.0 License.
54
Python logo ™ of the Python Software Foundation, used by Min RK with permission from the Foundation"""
56
intersphinx_mapping = {'python': ('http://docs.python.org/', None)}
57
# The version info for the project you're documenting, acts as replacement for
58
# |version| and |release|, also used in various other places throughout the
61
def extract_version():
62
"""extract pyzmq version from core/version.py, so it's not multiply defined"""
63
with open(os.path.join('..', '..', 'zmq', 'core', 'version.py')) as f:
65
while not line.startswith("__version__"):
70
vs = extract_version()
71
# The short X.Y version.
72
version = vs.rstrip(string.letters)
73
# The full version, including alpha/beta/rc tags.
76
# The language for content autogenerated by Sphinx. Refer to documentation
77
# for a list of supported languages.
80
# There are two options for replacing |today|: either, you set today to some
81
# non-false value, then it is used:
83
# Else, today_fmt is used as the format for a strftime call.
84
#today_fmt = '%B %d, %Y'
86
# List of documents that shouldn't be included in the build.
89
# List of directories, relative to source directory, that shouldn't be searched
91
exclude_trees = ['build']
93
# The reST default role (used for this markup: `text`) to use for all documents.
96
# If true, '()' will be appended to :func: etc. cross-reference text.
97
#add_function_parentheses = True
99
# If true, the current module name will be prepended to all description
100
# unit titles (such as .. function::).
101
#add_module_names = True
103
# If true, sectionauthor and moduleauthor directives will be shown in the
104
# output. They are ignored by default.
105
#show_authors = False
107
# The name of the Pygments (syntax highlighting) style to use.
108
pygments_style = 'sphinx'
110
# A list of ignored prefixes for module index sorting.
111
#modindex_common_prefix = []
114
# -- Options for HTML output ---------------------------------------------------
116
# The theme to use for HTML and HTML Help pages. Major themes that come with
117
# Sphinx are currently 'default' and 'sphinxdoc'.
118
html_theme = 'default'
120
# Theme options are theme-specific and customize the look and feel of a theme
121
# further. For a list of options available for each theme, see the
123
#html_theme_options = {}
125
# Add any paths that contain custom themes here, relative to this directory.
126
#html_theme_path = []
128
# The name for this set of Sphinx documents. If None, it defaults to
129
# "<project> v<release> documentation".
132
# A shorter title for the navigation bar. Default is the same as html_title.
133
#html_short_title = None
135
# The name of an image file (relative to this directory) to place at the top
139
# The name of an image file (within the static path) to use as favicon of the
140
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
142
html_favicon = 'zeromq.ico'
144
# Add any paths that contain custom static files (such as style sheets) here,
145
# relative to this directory. They are copied after the builtin static files,
146
# so a file named "default.css" will overwrite the builtin "default.css".
147
html_static_path = ['_static']
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'
153
# If true, SmartyPants will be used to convert quotes and dashes to
154
# typographically correct entities.
155
#html_use_smartypants = True
157
# Custom sidebar templates, maps document names to template names.
160
# Additional templates that should be rendered to pages, maps page names to
162
#html_additional_pages = {}
164
# If false, no module index is generated.
165
#html_use_modindex = True
167
# If false, no index is generated.
168
#html_use_index = True
170
# If true, the index is split into individual pages for each letter.
171
#html_split_index = False
173
# If true, links to the reST sources are added to the pages.
174
#html_show_sourcelink = True
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 = ''
181
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
182
#html_file_suffix = ''
184
# Output file base name for HTML help builder.
185
htmlhelp_basename = 'PyZMQdoc'
188
# -- Options for LaTeX output --------------------------------------------------
190
# The paper size ('letter' or 'a4').
191
#latex_paper_size = 'letter'
193
# The font size ('10pt', '11pt' or '12pt').
194
#latex_font_size = '10pt'
196
# Grouping the document tree into LaTeX files. List of tuples
197
# (source start file, target name, title, author, documentclass [howto/manual]).
199
('index', 'PyZMQ.tex', u'PyZMQ Documentation',
200
u'Brian E. Granger \\and Min Ragan-Kelley', 'manual'),
203
# The name of an image file (relative to this directory) to place at the top of
207
# For "manual" documents, if this is true, then toplevel headings are parts,
209
#latex_use_parts = False
211
# Additional stuff for the LaTeX preamble.
214
# Documents to append as an appendix to all manuals.
215
#latex_appendices = []
217
# If false, no module index is generated.
218
#latex_use_modindex = True
added
removed
docs/source/conf.py
