test/data/vclamp_jpk/README: Document sample versions
[hooke.git] / doc / conf.py
1 # -*- coding: utf-8 -*-
2 #
3 # sphinx-scons documentation build configuration file, created by
4 # sphinx-quickstart on Thu Mar 12 10:37:15 2009.
5 #
6 # This file is execfile()d with the current directory set to its containing dir.
7 #
8 # Note that not all possible configuration values are present in this
9 # autogenerated file.
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 extensions (or modules to document with autodoc) are in another directory,
17 # add these directories to sys.path here. If the directory is relative to the
18 # documentation root, use os.path.abspath to make it absolute, like shown here.
19 #sys.path.append(os.path.abspath('.'))
20 sys.path.insert(0, os.path.abspath('..'))
21
22 import hooke
23
24 # -- General configuration -----------------------------------------------------
25
26 # Add any Sphinx extension module names here, as strings. They can be extensions
27 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
28 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.autosummary',
29               'sphinx.ext.coverage', 'sphinx.ext.doctest', 
30               'sphinx.ext.intersphinx', 'sphinx.ext.pngmath',
31               'sphinx.ext.todo', 'numpydoc']
32
33 # Add any paths that contain templates here, relative to this directory.
34 templates_path = ['_templates']
35
36 # The suffix of source filenames.
37 source_suffix = '.txt' #'.rst'
38
39 # The encoding of source files.
40 #source_encoding = 'utf-8'
41
42 # The master toctree document.
43 master_doc = 'index'
44
45 # General information about the project.
46 project = u'Hooke'
47 copyright = u'2006-2010, Massimo Sandal et al.'
48
49 # The version info for the project you're documenting, acts as replacement for
50 # |version| and |release|, also used in various other places throughout the
51 # built documents.
52 #
53 # The short X.Y version.
54 version = hooke.version(2)
55 # The full version, including alpha/beta/rc tags.
56 release = hooke.version(5)
57
58 # The language for content autogenerated by Sphinx. Refer to documentation
59 # for a list of supported languages.
60 #language = None
61
62 # There are two options for replacing |today|: either, you set today to some
63 # non-false value, then it is used:
64 #today = ''
65 # Else, today_fmt is used as the format for a strftime call.
66 #today_fmt = '%B %d, %Y'
67
68 # List of documents that shouldn't be included in the build.
69 #unused_docs = []
70
71 # List of directories, relative to source directory, that shouldn't be searched
72 # for source files.
73 exclude_trees = ['build']
74
75 # The reST default role (used for this markup: `text`) to use for all documents.
76 #default_role = None
77
78 # If true, '()' will be appended to :func: etc. cross-reference text.
79 #add_function_parentheses = True
80
81 # If true, the current module name will be prepended to all description
82 # unit titles (such as .. function::).
83 #add_module_names = True
84
85 # If true, sectionauthor and moduleauthor directives will be shown in the
86 # output. They are ignored by default.
87 #show_authors = False
88
89 # The name of the Pygments (syntax highlighting) style to use.
90 pygments_style = 'sphinx'
91
92 # A list of ignored prefixes for module index sorting.
93 #modindex_common_prefix = []
94
95
96 # -- Options for HTML output ---------------------------------------------------
97
98 # The theme to use for HTML and HTML Help pages.  Major themes that come with
99 # Sphinx are currently 'default' and 'sphinxdoc'.
100 html_theme = 'default'
101
102 # Theme options are theme-specific and customize the look and feel of a theme
103 # further.  For a list of options available for each theme, see the
104 # documentation.
105 #html_theme_options = {}
106
107 # Add any paths that contain custom themes here, relative to this directory.
108 #html_theme_path = []
109
110 # The name for this set of Sphinx documents.  If None, it defaults to
111 # "<project> v<release> documentation".
112 html_title = project + " documentation"
113
114 # A shorter title for the navigation bar.  Default is the same as html_title.
115 #html_short_title = None
116
117 # The name of an image file (relative to this directory) to place at the top
118 # of the sidebar.
119 #html_logo = None
120
121 # The name of an image file (within the static path) to use as favicon of the
122 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
123 # pixels large.
124 #html_favicon = None
125
126 # Add any paths that contain custom static files (such as style sheets) here,
127 # relative to this directory. They are copied after the builtin static files,
128 # so a file named "default.css" will overwrite the builtin "default.css".
129 #html_static_path = ['_static']
130
131 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
132 # using the given strftime format.
133 #html_last_updated_fmt = '%b %d, %Y'
134
135 # If true, SmartyPants will be used to convert quotes and dashes to
136 # typographically correct entities.
137 #html_use_smartypants = True
138
139 # Custom sidebar templates, maps document names to template names.
140 #html_sidebars = {}
141
142 # Additional templates that should be rendered to pages, maps page names to
143 # template names.
144 #html_additional_pages = {}
145
146 # If false, no module index is generated.
147 #html_use_modindex = True
148
149 # If false, no index is generated.
150 #html_use_index = True
151
152 # If true, the index is split into individual pages for each letter.
153 #html_split_index = False
154
155 # If true, links to the reST sources are added to the pages.
156 #html_show_sourcelink = True
157
158 # If true, an OpenSearch description file will be output, and all pages will
159 # contain a <link> tag referring to it.  The value of this option must be the
160 # base URL from which the finished HTML is served.
161 #html_use_opensearch = ''
162
163 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
164 #html_file_suffix = ''
165
166 # Output file base name for HTML help builder.
167 htmlhelp_basename = 'sphinx-sconsdoc'
168
169
170 # -- Options for LaTeX output --------------------------------------------------
171
172 # The paper size ('letter' or 'a4').
173 #latex_paper_size = 'letter'
174
175 # The font size ('10pt', '11pt' or '12pt').
176 #latex_font_size = '10pt'
177
178 # Grouping the document tree into LaTeX files. List of tuples
179 # (source start file, target name, title, author, documentclass [howto/manual]).
180 latex_documents = [
181   ('index', 'hooke.tex', ur'Hooke Documentation',
182    ur'W. Trevor King', 'manual'),
183 ]
184
185 # The name of an image file (relative to this directory) to place at the top of
186 # the title page.
187 #latex_logo = None
188
189 # For "manual" documents, if this is true, then toplevel headings are parts,
190 # not chapters.
191 #latex_use_parts = False
192
193 # Additional stuff for the LaTeX preamble.
194 #latex_preamble = ''
195
196 # Documents to append as an appendix to all manuals.
197 #latex_appendices = []
198
199 # If false, no module index is generated.
200 #latex_use_modindex = True
201
202 # -- Options for intersphinx ---------------------------------------------------
203
204 intersphinx_mapping = {
205     'http://docs.python.org/dev/': None,
206     'http://docs.scipy.org/doc/numpy/': None,
207     'http://docs.scipy.org/doc/scipy/reference/': None,
208     'http://matplotlib.sourceforge.net/' : None,
209     }
210
211 # -- Options for pngmath -------------------------------------------------------
212
213 pngmath_latex_preamble = r"""
214 % \newcommand{\gaussian}{\textrm{gaussian}}
215 """
216
217 # -- Options for todo ----------------------------------------------------------
218
219 todo_include_todos = True