docs/conf.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # Cython documentation build configuration file, created by
   4 # sphinx-quickstart on Fri Apr 25 12:49:32 2008.
   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 # All configuration values have a default value; values that are commented out
  12 # serve to show the default value.
  13
  14 import sys
  15
  16 # If your extensions are in another directory, add it here.
  17 sys.path.append('sphinxext')
  18
  19 # Import support for ipython console session syntax highlighting (lives
  20 # in the sphinxext directory defined above)
  21 import ipython_console_highlighting
  22
  23 # General configuration
  24 # ---------------------
  25
  26 # Use cython as the default syntax highlighting language, as python is a subset
  27 # this does the right thing
  28 highlight_language = 'cython'
  29
  30 # Add any Sphinx extension module names here, as strings. They can be extensions
  31 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  32 extensions = ['ipython_console_highlighting', 'cython_highlighting', 'sphinx.ext.pngmath', 'sphinx.ext.todo']
  33
  34 # Add any paths that contain templates here, relative to this directory.
  35 templates_path = ['_templates']
  36
  37 # The suffix of source filenames.
  38 source_suffix = '.rst'
  39
  40 # The master toctree document.
  41 master_doc = 'index'
  42
  43 exclude_patterns = ['py*', 'build']
  44
  45 # General substitutions.
  46 project = 'Cython'
  47 copyright = '2011, Stefan Behnel, Robert Bradshaw, Dag Sverre Seljebotn, Greg Ewing, William Stein, Gabriel Gellner, et al.'
  48
  49 # The default replacements for |version| and |release|, also used in various
  50 # other places throughout the built documents.
  51 #
  52 # The short X.Y version.
  53 version = '0.15'
  54 # The full version, including alpha/beta/rc tags.
  55 release = '0.15pre'
  56
  57 # There are two options for replacing |today|: either, you set today to some
  58 # non-false value, then it is used:
  59 #today = ''
  60 # Else, today_fmt is used as the format for a strftime call.
  61 today_fmt = '%B %d, %Y'
  62
  63 # List of documents that shouldn't be included in the build.
  64 #unused_docs = []
  65
  66 # If true, '()' will be appended to :func: etc. cross-reference text.
  67 #add_function_parentheses = True
  68
  69 # If true, the current module name will be prepended to all description
  70 # unit titles (such as .. function::).
  71 #add_module_names = True
  72
  73 # If true, sectionauthor and moduleauthor directives will be shown in the
  74 # output. They are ignored by default.
  75 #show_authors = False
  76
  77 # The name of the Pygments (syntax highlighting) style to use.
  78 pygments_style = 'sphinx'
  79
  80 # Options for HTML output
  81 # -----------------------
  82
  83 # suffix for generated files
  84 html_file_suffix = '.html'
  85
  86 # The style sheet to use for HTML and HTML Help pages. A file of that name
  87 # must exist either in Sphinx' static/ path, or in one of the custom paths
  88 # given in html_static_path.
  89 html_style = 'default.css'
  90
  91 # Add any paths that contain custom static files (such as style sheets) here,
  92 # relative to this directory. They are copied after the builtin static files,
  93 # so a file named "default.css" will overwrite the builtin "default.css".
  94 html_static_path = ['_static']
  95
  96 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  97 # using the given strftime format.
  98 html_last_updated_fmt = '%b %d, %Y'
  99
 100 # Include the Cython logo in the sidebar
 101 html_logo = '_static/cython-logo-light.png'
 102
 103 # used a favicon!
 104 html_favicon = '_static/favicon.ico'
 105
 106 # If true, SmartyPants will be used to convert quotes and dashes to
 107 # typographically correct entities.
 108 #html_use_smartypants = True
 109
 110 # Content template for the index page.
 111 #html_index = ''
 112
 113 # Custom sidebar templates, maps document names to template names.
 114 #html_sidebars = {}
 115
 116 # Additional templates that should be rendered to pages, maps page names to
 117 # template names.
 118 #html_additional_pages = {}
 119
 120 # If false, no module index is generated.
 121 html_use_modindex = False
 122
 123 # Don't generate and index
 124 html_use_index = False
 125
 126 # If true, the reST sources are included in the HTML build as _sources/<name>.
 127 #html_copy_source = True
 128
 129 # Output file base name for HTML help builder.
 130 htmlhelp_basename = 'Cythondoc'
 131
 132
 133 # Options for LaTeX output
 134 # ------------------------
 135
 136 # The paper size ('letter' or 'a4').
 137 #latex_paper_size = 'letter'
 138
 139 # The font size ('10pt', '11pt' or '12pt').
 140 #latex_font_size = '10pt'
 141
 142 # Grouping the document tree into LaTeX files. List of tuples
 143 # (source start file, target name, title, author, document class [howto/manual]).
 144 #_stdauthor = r'Greg Ewig\\ Gabriel Gellner, editor'
 145 _stdauthor = r'Stefan Behnel, Robert Bradshaw, William Stein\\ Gary Furnish, Dag Seljebotn, Greg Ewing\\ Gabriel Gellner, editor'
 146 latex_documents = [
 147     ('src/reference/index', 'reference.tex',
 148      'Cython Reference Guide', _stdauthor, 'manual'),
 149     ('src/tutorial/index', 'tutorial.tex',
 150      'Cython Tutorial', _stdauthor, 'manual')
 151 ]
 152
 153 # Additional stuff for the LaTeX preamble.
 154 #latex_preamble = ''
 155
 156 # Documents to append as an appendix to all manuals.
 157 #latex_appendices = []
 158
 159 # If false, no module index is generated.
 160 #latex_use_modindex = True
 161
 162 # todo
 163 todo_include_todos = True