doc/conf.py.in

   1 # -*- coding: utf-8 -*-
   2 #
   3 # HexaBlock documentation build configuration file, created by
   4 # sphinx-quickstart on Fri Nov 19 14:09:24 2010.
   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; values that are commented out
  12 # serve to show the default.
  13
  14 import sys, os
  15
  16 # If your extensions are in another directory, add it here. If the directory
  17 # is relative to the documentation root, use os.path.abspath to make it
  18 # absolute, like shown here.
  19 sys.path.append(os.path.abspath('.'))
  20 #sys.path.append(os.path.abspath('sphinxext'))
  21
  22 # General configuration
  23 # ---------------------
  24
  25 # Add any Sphinx extension module names here, as strings. They can be extensions
  26 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  27 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest']
  28
  29 # extensions = ['matplotlib.sphinxext.mathmpl',
  30 #              'matplotlib.sphinxext.only_directives',
  31 #              'matplotlib.sphinxext.plot_directive',
  32 #              'sphinx.ext.autodoc',
  33 #              'sphinx.ext.doctest',
  34 #              'ipython_console_highlighting',
  35 #              'inheritance_diagram',
  36 #              'numpydoc']
  37
  38 # Add any paths that contain templates here, relative to this directory.
  39 templates_path = ['_templates']
  40
  41 # The suffix of source filenames.
  42 source_suffix = '.rst'
  43
  44 # The encoding of source files.
  45 #source_encoding = 'utf-8'
  46
  47 # The master toctree document.
  48 master_doc = 'index'
  49
  50 # General information about the project.
  51 project = u'HexaBlock'
  52 copyright = u'2009-2013  CEA/DEN, EDF R&D'
  53
  54 # The version info for the project you're documenting, acts as replacement for
  55 # |version| and |release|, also used in various other places throughout the
  56 # built documents.
  57 #
  58 # The short X.Y version.
  59 version = '@SHORT_VERSION@'
  60 # The full version, including alpha/beta/rc tags.
  61 release = '@VERSION@'
  62
  63 # The language for content autogenerated by Sphinx. Refer to documentation
  64 # for a list of supported languages.
  65 #language = None
  66
  67 # There are two options for replacing |today|: either, you set today to some
  68 # non-false value, then it is used:
  69 #today = ''
  70 # Else, today_fmt is used as the format for a strftime call.
  71 #today_fmt = '%B %d, %Y'
  72
  73 # List of documents that shouldn't be included in the build.
  74 #unused_docs = []
  75
  76 # List of directories, relative to source directory, that shouldn't be searched
  77 # for source files.
  78 exclude_trees = []
  79
  80 # The reST default role (used for this markup: `text`) to use for all documents.
  81 #default_role = None
  82
  83 # If true, '()' will be appended to :func: etc. cross-reference text.
  84 #add_function_parentheses = True
  85
  86 # If true, the current module name will be prepended to all description
  87 # unit titles (such as .. function::).
  88 #add_module_names = True
  89
  90 # If true, sectionauthor and moduleauthor directives will be shown in the
  91 # output. They are ignored by default.
  92 #show_authors = False
  93
  94 # The name of the Pygments (syntax highlighting) style to use.
  95 pygments_style = 'sphinx'
  96
  97
  98 # Options for HTML output
  99 # -----------------------
 100
 101 # The style sheet to use for HTML and HTML Help pages. A file of that name
 102 # must exist either in Sphinx' static/ path, or in one of the custom paths
 103 # given in html_static_path.
 104 html_style = 'default.css'
 105
 106 # The name for this set of Sphinx documents.  If None, it defaults to
 107 # "<project> v<release> documentation".
 108 #html_title = None
 109
 110 # A shorter title for the navigation bar.  Default is the same as html_title.
 111 #html_short_title = None
 112
 113 # The name of an image file (relative to this directory) to place at the top
 114 # of the sidebar.
 115 #html_logo = None
 116
 117 # The name of an image file (within the static path) to use as favicon of the
 118 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 119 # pixels large.
 120 #html_favicon = None
 121
 122 # Add any paths that contain custom static files (such as style sheets) here,
 123 # relative to this directory. They are copied after the builtin static files,
 124 # so a file named "default.css" will overwrite the builtin "default.css".
 125 html_static_path = ['_static']
 126
 127 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 128 # using the given strftime format.
 129 #html_last_updated_fmt = '%b %d, %Y'
 130
 131 # If true, SmartyPants will be used to convert quotes and dashes to
 132 # typographically correct entities.
 133 #html_use_smartypants = True
 134
 135 # Custom sidebar templates, maps document names to template names.
 136 #html_sidebars = {}
 137
 138 # Additional templates that should be rendered to pages, maps page names to
 139 # template names.
 140 #html_additional_pages = {}
 141
 142 # If false, no module index is generated.
 143 #html_use_modindex = True
 144
 145 # If false, no index is generated.
 146 #html_use_index = True
 147
 148 # If true, the index is split into individual pages for each letter.
 149 #html_split_index = False
 150
 151 # If true, the reST sources are included in the HTML build as _sources/<name>.
 152 #html_copy_source = True
 153
 154 # If true, an OpenSearch description file will be output, and all pages will
 155 # contain a <link> tag referring to it.  The value of this option must be the
 156 # base URL from which the finished HTML is served.
 157 #html_use_opensearch = ''
 158
 159 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
 160 #html_file_suffix = ''
 161
 162 # Output file base name for HTML help builder.
 163 htmlhelp_basename = 'HexaBlockdoc'
 164
 165
 166 # Options for LaTeX output
 167 # ------------------------
 168
 169 # The paper size ('letter' or 'a4').
 170 #latex_paper_size = 'letter'
 171
 172 # The font size ('10pt', '11pt' or '12pt').
 173 #latex_font_size = '10pt'
 174
 175 # Grouping the document tree into LaTeX files. List of tuples
 176 # (source start file, target name, title, author, document class [howto/manual]).
 177 latex_documents = [
 178   ('index', 'HexaBlock.tex', ur'HexaBlock Documentation',
 179    ur'CS', 'manual'),
 180 ]
 181
 182 # The name of an image file (relative to this directory) to place at the top of
 183 # the title page.
 184 #latex_logo = None
 185
 186 # For "manual" documents, if this is true, then toplevel headings are parts,
 187 # not chapters.
 188 #latex_use_parts = False
 189
 190 # Additional stuff for the LaTeX preamble.
 191 #latex_preamble = ''
 192
 193 # Documents to append as an appendix to all manuals.
 194 #latex_appendices = []
 195
 196 # If false, no module index is generated.
 197 #latex_use_modindex = True