/docs/source/conf.py
Python | 218 lines | 184 code | 10 blank | 24 comment | 0 complexity | 52448fd29ba219cb0cdc69a2e61520a5 MD5 | raw file
- # -*- coding: utf-8 -*-
- #
- # PyZMQ documentation build configuration file, created by
- # sphinx-quickstart on Sat Feb 20 23:31:19 2010.
- #
- # This file is execfile()d with the 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.
- import sys, os
- import string
- # If extensions (or modules to document with autodoc) are in another directory,
- # add these directories to sys.path here. If the directory is relative to the
- # documentation root, use os.path.abspath to make it absolute, like shown here.
- sys.path.insert(0,os.path.abspath('../sphinxext'))
- # patch autodoc to work with Cython Sources
- import sphinx_cython
- # -- General configuration -----------------------------------------------------
- # Add any Sphinx extension module names here, as strings. They can be extensions
- # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
- extensions = ['matplotlib.sphinxext.mathmpl',
- 'matplotlib.sphinxext.only_directives',
- 'matplotlib.sphinxext.plot_directive',
- 'sphinx.ext.autodoc',
- 'sphinx.ext.doctest',
- 'sphinx.ext.intersphinx',
- 'ipython_console_highlighting',
- 'numpydoc']
- # Add any paths that contain templates here, relative to this directory.
- 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'
- # General information about the project.
- project = u'PyZMQ'
- copyright = u"""2010-2011, Brian E. Granger & Min Ragan-Kelley.
- ØMQ logo © iMatix Corportation, used under the Creative Commons Attribution-Share Alike 3.0 License.
- Python logo ™ of the Python Software Foundation, used by Min RK with permission from the Foundation"""
- intersphinx_mapping = {'python': ('http://docs.python.org/', None)}
- # 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.
- #
- def extract_version():
- """extract pyzmq version from core/version.pyx, so it's not multiply defined"""
- with open(os.path.join('..', '..', 'zmq', 'core', 'version.pyx')) as f:
- line = f.readline()
- while not line.startswith("__version__"):
- line = f.readline()
- exec(line)
- return __version__
- vs = extract_version()
- # The short X.Y version.
- version = vs.rstrip(string.letters)
- # The full version, including alpha/beta/rc tags.
- release = vs
- # 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 = ['build']
- # 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
- # If true, the current module name will be prepended to all description
- # 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 = []
- # -- Options for HTML output ---------------------------------------------------
- # The theme to use for HTML and HTML Help pages. Major themes that come with
- # Sphinx are currently 'default' and 'sphinxdoc'.
- html_theme = 'default'
- # 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 = 'zeromq.ico'
- # Add any paths that contain custom static files (such as style sheets) here,
- # relative to this directory. They are copied after the builtin static files,
- # so a file named "default.css" will overwrite the builtin "default.css".
- html_static_path = ['_static']
- # 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 = 'PyZMQdoc'
- # -- Options for LaTeX 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', 'PyZMQ.tex', u'PyZMQ Documentation',
- u'Brian E. Granger \\and Min Ragan-Kelley', 'manual'),
- ]
- # 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