2 # -*- coding: utf-8 -*-
4 # FFT-tools documentation build configuration file, created by
5 # sphinx-quickstart on Mon Nov 19 01:53:51 2012.
7 # This file is execfile()d with the current directory set to its containing dir.
9 # Note that not all possible configuration values are present in this
12 # All configuration values have a default; values that are commented out
13 # serve to show the default.
18 # If extensions (or modules to document with autodoc) are in another directory,
19 # add these directories to sys.path here. If the directory is relative to the
20 # documentation root, use os.path.abspath to make it absolute, like shown here.
21 #sys.path.insert(0, os.path.abspath('.'))
23 # -- General configuration -----------------------------------------------------
25 # If your documentation needs a minimal Sphinx version, state it here.
28 # Add any Sphinx extension module names here, as strings. They can be extensions
29 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
32 'sphinx.ext.autosummary',
34 'sphinx.ext.intersphinx',
39 autosummary_generate = True
40 autodoc_default_flags = ['members']
42 # Add any paths that contain templates here, relative to this directory.
43 templates_path = ['_templates']
45 # The suffix of source filenames.
46 source_suffix = '.rst'
48 # The encoding of source files.
49 #source_encoding = 'utf-8-sig'
51 # The master toctree document.
54 # General information about the project.
56 author = 'W. Trevor King'
57 copyright = '2008-2012, {}'.format(author)
59 # The version info for the project you're documenting, acts as replacement for
60 # |version| and |release|, also used in various other places throughout the
63 # The short X.Y version.
65 # The full version, including alpha/beta/rc tags.
68 # The language for content autogenerated by Sphinx. Refer to documentation
69 # for a list of supported languages.
72 # There are two options for replacing |today|: either, you set today to some
73 # non-false value, then it is used:
75 # Else, today_fmt is used as the format for a strftime call.
76 #today_fmt = '%B %d, %Y'
78 # List of patterns, relative to source directory, that match files and
79 # directories to ignore when looking for source files.
82 # The reST default role (used for this markup: `text`) to use for all documents.
85 # If true, '()' will be appended to :func: etc. cross-reference text.
86 #add_function_parentheses = True
88 # If true, the current module name will be prepended to all description
89 # unit titles (such as .. function::).
90 #add_module_names = True
92 # If true, sectionauthor and moduleauthor directives will be shown in the
93 # output. They are ignored by default.
96 # The name of the Pygments (syntax highlighting) style to use.
97 pygments_style = 'sphinx'
99 # A list of ignored prefixes for module index sorting.
100 #modindex_common_prefix = []
103 # -- Options for HTML output ---------------------------------------------------
105 # The theme to use for HTML and HTML Help pages. See the documentation for
106 # a list of builtin themes.
107 html_theme = 'default'
109 # Theme options are theme-specific and customize the look and feel of a theme
110 # further. For a list of options available for each theme, see the
112 #html_theme_options = {}
114 # Add any paths that contain custom themes here, relative to this directory.
115 #html_theme_path = []
117 # The name for this set of Sphinx documents. If None, it defaults to
118 # "<project> v<release> documentation".
121 # A shorter title for the navigation bar. Default is the same as html_title.
122 #html_short_title = None
124 # The name of an image file (relative to this directory) to place at the top
128 # The name of an image file (within the static path) to use as favicon of the
129 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
133 # Add any paths that contain custom static files (such as style sheets) here,
134 # relative to this directory. They are copied after the builtin static files,
135 # so a file named "default.css" will overwrite the builtin "default.css".
136 html_static_path = ['_static']
138 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
139 # using the given strftime format.
140 #html_last_updated_fmt = '%b %d, %Y'
142 # If true, SmartyPants will be used to convert quotes and dashes to
143 # typographically correct entities.
144 #html_use_smartypants = True
146 # Custom sidebar templates, maps document names to template names.
149 # Additional templates that should be rendered to pages, maps page names to
151 #html_additional_pages = {}
153 # If false, no module index is generated.
154 #html_domain_indices = True
156 # If false, no index is generated.
157 #html_use_index = True
159 # If true, the index is split into individual pages for each letter.
160 #html_split_index = False
162 # If true, links to the reST sources are added to the pages.
163 #html_show_sourcelink = True
165 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
166 #html_show_sphinx = True
168 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
169 #html_show_copyright = True
171 # If true, an OpenSearch description file will be output, and all pages will
172 # contain a <link> tag referring to it. The value of this option must be the
173 # base URL from which the finished HTML is served.
174 #html_use_opensearch = ''
176 # This is the file name suffix for HTML files (e.g. ".xhtml").
177 #html_file_suffix = None
179 # Output file base name for HTML help builder.
180 htmlhelp_basename = 'FFT-toolsdoc'
183 # -- Options for LaTeX output --------------------------------------------------
185 latex_preamble = r"""
186 \newcommand{\gaussian}{\textrm{gaussian}}
187 \newcommand{\rect}{\textrm{rect}}
188 \newcommand{\rfft}{\textrm{rfft}}
189 \newcommand{\sinc}{\textrm{sinc}}
193 # The paper size ('letterpaper' or 'a4paper').
194 #'papersize': 'letterpaper',
196 # The font size ('10pt', '11pt' or '12pt').
197 #'pointsize': '10pt',
199 # Additional stuff for the LaTeX preamble.
200 'preamble': latex_preamble,
203 # Grouping the document tree into LaTeX files. List of tuples
204 # (source start file, target name, title, author, documentclass [howto/manual]).
206 ('index', '{}.tex'.format(project), '{} Documentation'.format(project),
210 # The name of an image file (relative to this directory) to place at the top of
214 # For "manual" documents, if this is true, then toplevel headings are parts,
216 #latex_use_parts = False
218 # If true, show page references after internal links.
219 #latex_show_pagerefs = False
221 # If true, show URL addresses after external links.
222 #latex_show_urls = False
224 # Documents to append as an appendix to all manuals.
225 #latex_appendices = []
227 # If false, no module index is generated.
228 #latex_domain_indices = True
231 # -- Options for manual page output --------------------------------------------
233 # One entry per manual page. List of tuples
234 # (source start file, name, description, authors, manual section).
236 ('index', project.lower(), '{} Documentation'.format(project),
240 # If true, show URL addresses after external links.
241 #man_show_urls = False
244 # -- Options for Texinfo output ------------------------------------------------
246 # Grouping the document tree into Texinfo files. List of tuples
247 # (source start file, target name, title, author,
248 # dir menu entry, description, category)
249 texinfo_documents = [
250 ('index', project, '{} Documentation'.format(project),
251 author, project, "Wrap Numpy's fft module to reduce clutter.",
255 # Documents to append as an appendix to all manuals.
256 #texinfo_appendices = []
258 # If false, no module index is generated.
259 #texinfo_domain_indices = True
261 # How to display URL addresses: 'footnote', 'no', or 'inline'.
262 #texinfo_show_urls = 'footnote'
265 # Example configuration for intersphinx: refer to the Python standard library.
266 intersphinx_mapping = {
267 'python': ('http://docs.python.org/', None),
268 'numpy':('http://docs.scipy.org/doc/numpy',None),
272 # -- Options for pngmath ------------------------------------------------------
274 pngmath_latex_preamble = latex_preamble