1
# -*- coding: utf-8 -*-
3
# pyxfaq documentation build configuration file, created by
4
# sphinx-quickstart on Sun Jun 12 16:54:07 2011.
6
# This file is execfile()d with the current directory set to its containing dir.
8
# Note that not all possible configuration values are present in this
11
# All configuration values have a default; values that are commented out
12
# serve to show the default.
15
sys.path.insert(0, '..')
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.
30
extensions = ['sphinx.ext.todo']
32
# Add any paths that contain templates here, relative to this directory.
33
templates_path = ['_templates']
35
# The suffix of source filenames.
36
source_suffix = '.rst'
38
# The encoding of source files.
39
#source_encoding = 'utf-8-sig'
41
# The master toctree document.
44
# General information about the project.
46
copyright = u'2011, Gert-Ludwig Ingold'
48
# The version info for the project you're documenting, acts as replacement for
49
# |version| and |release|, also used in various other places throughout the
52
# The short X.Y version.
53
version = '.'.join(pyx.version.version.split('.')[:1])
54
# The full version, including alpha/beta/rc tags.
55
release = pyx.version.version
57
# The language for content autogenerated by Sphinx. Refer to documentation
58
# for a list of supported languages.
61
# There are two options for replacing |today|: either, you set today to some
62
# non-false value, then it is used:
63
today = pyx.version.date
64
# Else, today_fmt is used as the format for a strftime call.
65
#today_fmt = '%B %d, %Y'
67
# List of patterns, relative to source directory, that match files and
68
# directories to ignore when looking for source files.
69
exclude_patterns = ['_build']
71
# The reST default role (used for this markup: `text`) to use for all documents.
74
# If true, '()' will be appended to :func: etc. cross-reference text.
75
#add_function_parentheses = True
77
# If true, the current module name will be prepended to all description
78
# unit titles (such as .. function::).
79
#add_module_names = True
81
# If true, sectionauthor and moduleauthor directives will be shown in the
82
# output. They are ignored by default.
85
# The name of the Pygments (syntax highlighting) style to use.
86
pygments_style = 'sphinx'
88
# A list of ignored prefixes for module index sorting.
89
#modindex_common_prefix = []
92
# -- Options for HTML output ---------------------------------------------------
94
# The theme to use for HTML and HTML Help pages. See the documentation for
95
# a list of builtin themes.
96
html_theme = 'default'
98
# Theme options are theme-specific and customize the look and feel of a theme
99
# further. For a list of options available for each theme, see the
101
#html_theme_options = {}
103
# Add any paths that contain custom themes here, relative to this directory.
104
#html_theme_path = []
106
# The name for this set of Sphinx documents. If None, it defaults to
107
# "<project> v<release> documentation".
108
html_title = 'PyX FAQ'
110
# A shorter title for the navigation bar. Default is the same as html_title.
111
#html_short_title = None
113
# The name of an image file (relative to this directory) to place at the top
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
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']
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'
131
# If true, SmartyPants will be used to convert quotes and dashes to
132
# typographically correct entities.
133
#html_use_smartypants = True
135
# Custom sidebar templates, maps document names to template names.
138
# Additional templates that should be rendered to pages, maps page names to
140
#html_additional_pages = {}
142
# If false, no module index is generated.
143
#html_domain_indices = True
145
# If false, no index is generated.
146
#html_use_index = True
148
# If true, the index is split into individual pages for each letter.
149
#html_split_index = False
151
# If true, links to the reST sources are added to the pages.
152
#html_show_sourcelink = True
154
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
155
#html_show_sphinx = True
157
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
158
#html_show_copyright = True
160
# If true, an OpenSearch description file will be output, and all pages will
161
# contain a <link> tag referring to it. The value of this option must be the
162
# base URL from which the finished HTML is served.
163
#html_use_opensearch = ''
165
# This is the file name suffix for HTML files (e.g. ".xhtml").
166
#html_file_suffix = None
168
# Output file base name for HTML help builder.
169
htmlhelp_basename = 'pyxfaqdoc'
171
todo_include_todos = True # gli
174
# -- Options for LaTeX output --------------------------------------------------
176
# The paper size ('letter' or 'a4').
177
latex_paper_size = 'a4'
179
# The font size ('10pt', '11pt' or '12pt').
180
#latex_font_size = '10pt'
182
# Grouping the document tree into LaTeX files. List of tuples
183
# (source start file, target name, title, author, documentclass [howto/manual]).
185
('index', 'pyxfaq.tex', u'Some frequently and not so frequently asked questions about PyX',
186
u'Gert-Ludwig Ingold', 'manual'),
189
# The name of an image file (relative to this directory) to place at the top of
193
# For "manual" documents, if this is true, then toplevel headings are parts,
195
#latex_use_parts = False
197
# If true, show page references after internal links.
198
#latex_show_pagerefs = False
200
# If true, show URL addresses after external links.
201
#latex_show_urls = False
203
# Additional stuff for the LaTeX preamble.
204
latex_preamble = r'''
205
\hypersetup{pdftitle={%s},
206
pdfauthor={Gert-Ludwig Ingold <gert.ingold@physik.uni-augsburg.de>},
207
pdfsubject={FAQ for PyX},
208
pdfkeywords={PyX, graphics, tipps and tricks, FAQ}}
209
''' % latex_documents[0][2]
211
# Documents to append as an appendix to all manuals.
212
#latex_appendices = []
214
# If false, no module index is generated.
215
#latex_domain_indices = True
218
# -- Options for manual page output --------------------------------------------
220
# One entry per manual page. List of tuples
221
# (source start file, name, description, authors, manual section).
223
('index', 'pyxfaq', u'pyxfaq Documentation',
224
[u'Gert-Ludwig Ingold'], 1)
added
removed
faq/conf.py
