The Tor Browser: python/mock-1.0.0/docs/conf.py@b8a032363ba2 (annotated)

python/mock-1.0.0/docs/conf.py@b8a032363ba2 (annotated)

python/mock-1.0.0/docs/conf.py

Thu, 22 Jan 2015 13:21:57 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Thu, 22 Jan 2015 13:21:57 +0100
branch: TOR_BUG_9701
changeset 15: b8a032363ba2
permissions: -rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

 # -*- coding: utf-8 -*-
 #
 # Mock documentation build configuration file, created by
 # sphinx-quickstart on Mon Nov 17 18:12:00 2008.
 #
 # This file is execfile()d with the current directory set to its containing dir.
 #
 # The contents of this file are pickled, so don't put values in the namespace
 # that aren't pickleable (module imports are okay, they're removed automatically).
 #
 # All configuration values have a default value; values that are commented out
 # serve to show the default value.
 import sys, os
 sys.path.insert(0, os.path.abspath('..'))
 from mock import __version__
 # If your extensions are in another directory, add it here. If the directory
 # is relative to the documentation root, use os.path.abspath to make it
 # absolute, like shown here.
 #sys.path.append(os.path.abspath('some/directory'))
 # 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 = ['sphinx.ext.doctest']
 doctest_global_setup = """
 import os
 import sys
 import mock
 from mock import * # yeah, I know :-/
 import unittest2
 import __main__
 if os.getcwd() not in sys.path:
     sys.path.append(os.getcwd())
 # keep a reference to __main__
 sys.modules['__main'] = __main__
 class ProxyModule(object):
     def __init__(self):
         self.__dict__ = globals()
 sys.modules['__main__'] = ProxyModule()
 """
 doctest_global_cleanup = """
 sys.modules['__main__'] = sys.modules['__main']
 """
 html_theme = 'nature'
 html_theme_options = {}
 # Add any paths that contain templates here, relative to this directory.
 #templates_path = ['_templates']
 # The suffix of source filenames.
 source_suffix = '.txt'
 # The master toctree document.
 master_doc = 'index'
 # General substitutions.
 project = u'Mock'
 copyright = u'2007-2012, Michael Foord & the mock team'
 # The default replacements for |version| and |release|, also used in various
 # other places throughout the built documents.
 #
 # The short X.Y version.
 version = __version__[:3]
 # The full version, including alpha/beta/rc tags.
 release = __version__
 # 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 directories, 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
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
 add_module_names = False
 # 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 = 'friendly'
 # Options for HTML output
 # -----------------------
 # The style sheet to use for HTML and HTML Help pages. A file of that name
 # must exist either in Sphinx' static/ path, or in one of the custom paths
 # given in html_static_path.
 #html_style = 'adctheme.css'
 # 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
 # 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 = False
 # 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, the reST sources are included in the HTML build as _sources/<name>.
 #html_copy_source = 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 = 'Mockdoc'
 # Options for LaTeX output
 # ------------------------
 # The paper size ('letter' or 'a4').
 #latex_paper_size = 'letter'
 # The font size ('10pt', '11pt' or '12pt').
 latex_font_size = '12pt'
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, document class [howto/manual]).
 latex_documents = [
   ('index', 'Mock.tex', u'Mock Documentation',
    u'Michael Foord', '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 = False

The Tor Browser / annotate

python/mock-1.0.0/docs/conf.py@b8a032363ba2 (annotated)

python/mock-1.0.0/docs/conf.py