|
1 | 1 | # -*- coding: utf-8 -*- |
2 | | -# |
3 | | -# Effect documentation build configuration file, created by |
4 | | -# sphinx-quickstart on Mon Dec 22 12:01:30 2014. |
5 | | -# |
6 | | -# This file is execfile()d with the current directory set to its |
7 | | -# containing dir. |
8 | | -# |
9 | | -# Note that not all possible configuration values are present in this |
10 | | -# autogenerated file. |
11 | | -# |
12 | | -# All configuration values have a default; values that are commented out |
13 | | -# serve to show the default. |
14 | 2 |
|
15 | | -import sys |
16 | | -import os |
17 | | - |
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('.')) |
22 | | - |
23 | | -# -- General configuration ------------------------------------------------ |
24 | | - |
25 | | -# If your documentation needs a minimal Sphinx version, state it here. |
26 | | -#needs_sphinx = '1.0' |
27 | | - |
28 | | -# Add any Sphinx extension module names here, as strings. They can be |
29 | | -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
30 | | -# ones. |
31 | 3 | extensions = [ |
32 | 4 | 'sphinx.ext.autodoc', |
33 | 5 | 'sphinx.ext.viewcode', |
34 | 6 | ] |
35 | 7 |
|
36 | | -# RADIX CUSTOMIZATION |
| 8 | +# include __init__ docstrings in class docstrings |
37 | 9 | autoclass_content = 'both' |
38 | 10 |
|
39 | | -# Add any paths that contain templates here, relative to this directory. |
40 | | -templates_path = ['_templates'] |
41 | | - |
42 | | -# The suffix of source filenames. |
43 | 11 | source_suffix = '.rst' |
44 | | - |
45 | | -# The encoding of source files. |
46 | | -#source_encoding = 'utf-8-sig' |
47 | | - |
48 | | -# The master toctree document. |
49 | 12 | master_doc = 'index' |
50 | | - |
51 | | -# General information about the project. |
52 | 13 | project = u'Effect' |
53 | 14 | copyright = u'2015, Christopher Armstrong' |
| 15 | +version = release = '0.9' |
54 | 16 |
|
55 | | -# The version info for the project you're documenting, acts as replacement for |
56 | | -# |version| and |release|, also used in various other places throughout the |
57 | | -# built documents. |
58 | | -# |
59 | | -# The short X.Y version. |
60 | | -version = '0.1a19' |
61 | | -# The full version, including alpha/beta/rc tags. |
62 | | -release = '0.1a19' |
63 | | - |
64 | | -# The language for content autogenerated by Sphinx. Refer to documentation |
65 | | -# for a list of supported languages. |
66 | | -#language = None |
67 | | - |
68 | | -# There are two options for replacing |today|: either, you set today to some |
69 | | -# non-false value, then it is used: |
70 | | -#today = '' |
71 | | -# Else, today_fmt is used as the format for a strftime call. |
72 | | -#today_fmt = '%B %d, %Y' |
73 | | - |
74 | | -# List of patterns, relative to source directory, that match files and |
75 | | -# directories to ignore when looking for source files. |
76 | | -exclude_patterns = [] |
77 | | - |
78 | | -# The reST default role (used for this markup: `text`) to use for all |
79 | | -# documents. |
80 | | -#default_role = None |
81 | | - |
82 | | -# If true, '()' will be appended to :func: etc. cross-reference text. |
83 | | -#add_function_parentheses = True |
84 | | - |
85 | | -# If true, the current module name will be prepended to all description |
86 | | -# unit titles (such as .. function::). |
87 | | -#add_module_names = True |
88 | | - |
89 | | -# If true, sectionauthor and moduleauthor directives will be shown in the |
90 | | -# output. They are ignored by default. |
91 | | -#show_authors = False |
92 | | - |
93 | | -# The name of the Pygments (syntax highlighting) style to use. |
94 | | -pygments_style = 'sphinx' |
95 | | - |
96 | | -# A list of ignored prefixes for module index sorting. |
97 | | -#modindex_common_prefix = [] |
98 | | - |
99 | | -# If true, keep warnings as "system message" paragraphs in the built documents. |
100 | | -#keep_warnings = False |
101 | | - |
102 | | - |
103 | | -# -- Options for HTML output ---------------------------------------------- |
104 | | - |
105 | | -# The theme to use for HTML and HTML Help pages. See the documentation for |
106 | | -# a list of builtin themes. |
107 | | -# html_theme = 'alabaster' |
108 | | - |
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 |
111 | | -# documentation. |
112 | | -#html_theme_options = {} |
113 | | - |
114 | | -# Add any paths that contain custom themes here, relative to this directory. |
115 | | -# html_theme_path = [alabaster.get_path()] # radix |
116 | | - |
117 | | -# The name for this set of Sphinx documents. If None, it defaults to |
118 | | -# "<project> v<release> documentation". |
119 | | -#html_title = None |
120 | | - |
121 | | -# A shorter title for the navigation bar. Default is the same as html_title. |
122 | | -#html_short_title = None |
123 | | - |
124 | | -# The name of an image file (relative to this directory) to place at the top |
125 | | -# of the sidebar. |
126 | | -#html_logo = None |
127 | | - |
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 |
130 | | -# pixels large. |
131 | | -#html_favicon = None |
132 | | - |
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'] |
137 | | - |
138 | | -# Add any extra paths that contain custom files (such as robots.txt or |
139 | | -# .htaccess) here, relative to this directory. These files are copied |
140 | | -# directly to the root of the documentation. |
141 | | -#html_extra_path = [] |
142 | | - |
143 | | -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
144 | | -# using the given strftime format. |
145 | | -#html_last_updated_fmt = '%b %d, %Y' |
146 | | - |
147 | | -# If true, SmartyPants will be used to convert quotes and dashes to |
148 | | -# typographically correct entities. |
149 | | -#html_use_smartypants = True |
150 | | - |
151 | | -# Custom sidebar templates, maps document names to template names. |
152 | | -html_sidebars = { # radix |
153 | | - '**': ['about.html', 'navigation.html', 'searchbox.html', 'donate.html'], |
154 | | -} |
155 | | - |
156 | | -# Additional templates that should be rendered to pages, maps page names to |
157 | | -# template names. |
158 | | -#html_additional_pages = {} |
159 | | - |
160 | | -# If false, no module index is generated. |
161 | | -#html_domain_indices = True |
162 | | - |
163 | | -# If false, no index is generated. |
164 | | -#html_use_index = True |
165 | | - |
166 | | -# If true, the index is split into individual pages for each letter. |
167 | | -#html_split_index = False |
168 | | - |
169 | | -# If true, links to the reST sources are added to the pages. |
170 | | -#html_show_sourcelink = True |
171 | | - |
172 | | -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
173 | | -#html_show_sphinx = True |
174 | | - |
175 | | -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
176 | | -#html_show_copyright = True |
177 | | - |
178 | | -# If true, an OpenSearch description file will be output, and all pages will |
179 | | -# contain a <link> tag referring to it. The value of this option must be the |
180 | | -# base URL from which the finished HTML is served. |
181 | | -#html_use_opensearch = '' |
182 | | - |
183 | | -# This is the file name suffix for HTML files (e.g. ".xhtml"). |
184 | | -#html_file_suffix = None |
185 | | - |
186 | | -# Output file base name for HTML help builder. |
187 | | -htmlhelp_basename = 'Effectdoc' |
188 | | - |
189 | | - |
190 | | -# -- Options for LaTeX output --------------------------------------------- |
191 | | - |
192 | | -latex_elements = { |
193 | | -# The paper size ('letterpaper' or 'a4paper'). |
194 | | -#'papersize': 'letterpaper', |
195 | | - |
196 | | -# The font size ('10pt', '11pt' or '12pt'). |
197 | | -#'pointsize': '10pt', |
198 | | - |
199 | | -# Additional stuff for the LaTeX preamble. |
200 | | -#'preamble': '', |
201 | | -} |
202 | | - |
203 | | -# Grouping the document tree into LaTeX files. List of tuples |
204 | | -# (source start file, target name, title, |
205 | | -# author, documentclass [howto, manual, or own class]). |
206 | | -latex_documents = [ |
207 | | - ('index', 'Effect.tex', u'Effect Documentation', |
208 | | - u'Christopher Armstrong', 'manual'), |
209 | | -] |
210 | | - |
211 | | -# The name of an image file (relative to this directory) to place at the top of |
212 | | -# the title page. |
213 | | -#latex_logo = None |
214 | | - |
215 | | -# For "manual" documents, if this is true, then toplevel headings are parts, |
216 | | -# not chapters. |
217 | | -#latex_use_parts = False |
218 | | - |
219 | | -# If true, show page references after internal links. |
220 | | -#latex_show_pagerefs = False |
221 | | - |
222 | | -# If true, show URL addresses after external links. |
223 | | -#latex_show_urls = False |
224 | | - |
225 | | -# Documents to append as an appendix to all manuals. |
226 | | -#latex_appendices = [] |
227 | | - |
228 | | -# If false, no module index is generated. |
229 | | -#latex_domain_indices = True |
230 | | - |
231 | | - |
232 | | -# -- Options for manual page output --------------------------------------- |
233 | | - |
234 | | -# One entry per manual page. List of tuples |
235 | | -# (source start file, name, description, authors, manual section). |
236 | | -man_pages = [ |
237 | | - ('index', 'effect', u'Effect Documentation', |
238 | | - [u'Christopher Armstrong'], 1) |
239 | | -] |
240 | | - |
241 | | -# If true, show URL addresses after external links. |
242 | | -#man_show_urls = False |
243 | | - |
244 | | - |
245 | | -# -- Options for Texinfo output ------------------------------------------- |
246 | | - |
247 | | -# Grouping the document tree into Texinfo files. List of tuples |
248 | | -# (source start file, target name, title, author, |
249 | | -# dir menu entry, description, category) |
250 | | -texinfo_documents = [ |
251 | | - ('index', 'Effect', u'Effect Documentation', |
252 | | - u'Christopher Armstrong', 'Effect', 'One line description of project.', |
253 | | - 'Miscellaneous'), |
254 | | -] |
255 | | - |
256 | | -# Documents to append as an appendix to all manuals. |
257 | | -#texinfo_appendices = [] |
258 | | - |
259 | | -# If false, no module index is generated. |
260 | | -#texinfo_domain_indices = True |
261 | | - |
262 | | -# How to display URL addresses: 'footnote', 'no', or 'inline'. |
263 | | -#texinfo_show_urls = 'footnote' |
264 | 17 |
|
265 | | -# If true, do not generate a @detailmenu in the "Top" node's menu. |
266 | | -#texinfo_no_detailmenu = False |
0 commit comments