doc/conf.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # nose documentation build configuration file, created by
   4 # sphinx-quickstart on Thu Mar 26 16:49:00 2009.
   5 #
   6 # This file is execfile()d with the current directory set to its containing dir.
   7 #
   8 # The contents of this file are pickled, so don't put values in the namespace
   9 # that aren't pickleable (module imports are okay, they're removed automatically).
  10 #
  11 # Note that not all possible configuration values are present in this
  12 # autogenerated file.
  13 #
  14 # All configuration values have a default; values that are commented out
  15 # serve to show the default.
  16
  17 import sys, os
  18
  19 # If your extensions are in another directory, add it here. If the directory
  20 # is relative to the documentation root, use os.path.abspath to make it
  21 # absolute, like shown here.
  22
  23 # need to be brutal because of easy_install's pth hacks:
  24 sys.path.insert(0,
  25     os.path.join(os.path.dirname(__file__), '..'))
  26 sys.path.insert(0, os.path.abspath('.'))
  27
  28
  29 # General configuration
  30 # ---------------------
  31
  32 # Add any Sphinx extension module names here, as strings. They can be extensions
  33 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  34 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx',
  35               'nose.sphinx.pluginopts', 'manbuilder']
  36
  37 # Add any paths that contain templates here, relative to this directory.
  38 templates_path = ['.templates']
  39
  40 # The suffix of source filenames.
  41 source_suffix = '.rst'
  42
  43 # The encoding of source files.
  44 #source_encoding = 'utf-8'
  45
  46 # The master toctree document.
  47 master_doc = 'index'
  48
  49 # General information about the project.
  50 project = u'nose'
  51 copyright = u'2009, Jason Pellerin'
  52
  53 # The version info for the project you're documenting, acts as replacement for
  54 # |version| and |release|, also used in various other places throughout the
  55 # built documents.
  56 #
  57 # The short X.Y version.
  58 version = '1.1'
  59 # The full version, including alpha/beta/rc tags.
  60 release = '1.1.2'
  61
  62 # The language for content autogenerated by Sphinx. Refer to documentation
  63 # for a list of supported languages.
  64 #language = None
  65
  66 # There are two options for replacing |today|: either, you set today to some
  67 # non-false value, then it is used:
  68 #today = ''
  69 # Else, today_fmt is used as the format for a strftime call.
  70 #today_fmt = '%B %d, %Y'
  71
  72 # List of documents that shouldn't be included in the build.
  73 #unused_docs = []
  74
  75 # List of directories, relative to source directory, that shouldn't be searched
  76 # for source files.
  77 exclude_trees = ['.build']
  78
  79 # The reST default role (used for this markup: `text`) to use for all documents.
  80 #default_role = None
  81
  82 # If true, '()' will be appended to :func: etc. cross-reference text.
  83 #add_function_parentheses = True
  84
  85 # If true, the current module name will be prepended to all description
  86 # unit titles (such as .. function::).
  87 #add_module_names = True
  88
  89 # If true, sectionauthor and moduleauthor directives will be shown in the
  90 # output. They are ignored by default.
  91 #show_authors = False
  92
  93 # The name of the Pygments (syntax highlighting) style to use.
  94 pygments_style = 'trac'
  95
  96
  97 # Options for HTML output
  98 # -----------------------
  99
 100 # The style sheet to use for HTML and HTML Help pages. A file of that name
 101 # must exist either in Sphinx' static/ path, or in one of the custom paths
 102 # given in html_static_path.
 103 html_style = 'nose.css'
 104
 105 # The name for this set of Sphinx documents.  If None, it defaults to
 106 # "<project> v<release> documentation".
 107 #html_title = None
 108
 109 # A shorter title for the navigation bar.  Default is the same as html_title.
 110 #html_short_title = None
 111
 112 # The name of an image file (relative to this directory) to place at the top
 113 # of the sidebar.
 114 #html_logo = None
 115
 116 # The name of an image file (within the static path) to use as favicon of the
 117 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 118 # pixels large.
 119 #html_favicon = None
 120
 121 # Add any paths that contain custom static files (such as style sheets) here,
 122 # relative to this directory. They are copied after the builtin static files,
 123 # so a file named "default.css" will overwrite the builtin "default.css".
 124 html_static_path = ['.static']
 125
 126 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 127 # using the given strftime format.
 128 #html_last_updated_fmt = '%b %d, %Y'
 129
 130 # If true, SmartyPants will be used to convert quotes and dashes to
 131 # typographically correct entities.
 132 #html_use_smartypants = True
 133
 134 # Custom sidebar templates, maps document names to template names.
 135 html_sidebars = {
 136     'index': 'indexsidebar.html'
 137     }
 138
 139 # Additional templates that should be rendered to pages, maps page names to
 140 # template names.
 141 # html_additional_pages = {'index': 'index.html'}
 142
 143 # If false, no module index is generated.
 144 #html_use_modindex = True
 145
 146 # If false, no index is generated.
 147 #html_use_index = True
 148
 149 # If true, the index is split into individual pages for each letter.
 150 #html_split_index = False
 151
 152 # If true, the reST sources are included in the HTML build as _sources/<name>.
 153 #html_copy_source = True
 154
 155 # If true, an OpenSearch description file will be output, and all pages will
 156 # contain a <link> tag referring to it.  The value of this option must be the
 157 # base URL from which the finished HTML is served.
 158 #html_use_opensearch = ''
 159
 160 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
 161 #html_file_suffix = ''
 162
 163 # Output file base name for HTML help builder.
 164 htmlhelp_basename = 'nosedoc'
 165
 166 """
 167 footerbgcolor (CSS color): Background color for the footer line.
 168 footertextcolor (CSS color): Text color for the footer line.
 169 sidebarbgcolor (CSS color): Background color for the sidebar.
 170 sidebartextcolor (CSS color): Text color for the sidebar.
 171 sidebarlinkcolor (CSS color): Link color for the sidebar.
 172 relbarbgcolor (CSS color): Background color for the relation bar.
 173 relbartextcolor (CSS color): Text color for the relation bar.
 174 relbarlinkcolor (CSS color): Link color for the relation bar.
 175 bgcolor (CSS color): Body background color.
 176 textcolor (CSS color): Body text color.
 177 linkcolor (CSS color): Body link color.
 178 headbgcolor (CSS color): Background color for headings.
 179 headtextcolor (CSS color): Text color for headings.
 180 headlinkcolor (CSS color): Link color for headings.
 181 codebgcolor (CSS color): Background color for code blocks.
 182 codetextcolor (CSS color): Default text color for code blocks, if not set differently by the highlighting style.
 183 bodyfont (CSS font-family): Font for normal text.
 184 headfont (CSS font-family): Font for headings.
 185 """
 186 html_theme_options = {
 187     'rightsidebar': 'true',
 188     'sidebarbgcolor': '#fff',
 189     'sidebartextcolor': '#20435c',
 190     'sidebarlinkcolor': '#355f7c',
 191     'bgcolor': '#fff',
 192     'codebgcolor': '#ffe',
 193     'headbgcolor': '#fff',
 194     'relbarbgcolor': '#fff',
 195     'relbartextcolor': '#20435c',
 196     'relbarlinkcolor': '#355f7c',
 197 }
 198
 199 # the css mostly overrides this:
 200 html_theme = 'default'
 201
 202 # Options for LaTeX output
 203 # ------------------------
 204
 205 # The paper size ('letter' or 'a4').
 206 #latex_paper_size = 'letter'
 207
 208 # The font size ('10pt', '11pt' or '12pt').
 209 #latex_font_size = '10pt'
 210
 211 # Grouping the document tree into LaTeX files. List of tuples
 212 # (source start file, target name, title, author, document class [howto/manual]).
 213 latex_documents = [
 214   ('index', 'nose.tex', ur'nose Documentation',
 215    ur'Jason Pellerin', 'manual'),
 216 ]
 217
 218 # The name of an image file (relative to this directory) to place at the top of
 219 # the title page.
 220 #latex_logo = None
 221
 222 # For "manual" documents, if this is true, then toplevel headings are parts,
 223 # not chapters.
 224 #latex_use_parts = False
 225
 226 # Additional stuff for the LaTeX preamble.
 227 #latex_preamble = ''
 228
 229 # Documents to append as an appendix to all manuals.
 230 #latex_appendices = []
 231
 232 # If false, no module index is generated.
 233 #latex_use_modindex = True
 234
 235
 236 # Example configuration for intersphinx: refer to the Python standard library.
 237 intersphinx_mapping = {'http://docs.python.org/dev': None}