Merge branch 'release/0.9.2'
[philo.git] / docs / conf.py
1 # -*- coding: utf-8 -*-
2 #
3 # Philo documentation build configuration file, created by
4 # sphinx-quickstart on Fri Jan 28 14:04:16 2011.
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(os.path.join(os.path.dirname(__file__), "_ext")))
20 sys.path.append(os.path.abspath(os.path.dirname(os.path.dirname(__file__))))
21
22 os.environ['DJANGO_SETTINGS_MODULE'] = 'dummy-settings'
23
24 # Import loader so that loader_tags will be correctly added to builtins. Weird import situations... this is necessary for doc build to work.
25 from django.template import loader
26
27 # HACK to override descriptors that would cause AttributeErrors to be raised otherwise (which would keep them from being documented.)
28 from philo.contrib.sobol.models import SearchView
29 SearchView.searches = 5
30 from philo.models.nodes import TargetURLModel, File
31 TargetURLModel.reversing_parameters = 5
32 File.file = 5
33
34 # -- General configuration -----------------------------------------------------
35
36 # If your documentation needs a minimal Sphinx version, state it here.
37 needs_sphinx = '1.0'
38
39 # Add any Sphinx extension module names here, as strings. They can be extensions
40 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
41 extensions = ['djangodocs', 'sphinx.ext.autodoc', 'philodocs']
42
43 # Add any paths that contain templates here, relative to this directory.
44 templates_path = ['_templates']
45
46 # The suffix of source filenames.
47 source_suffix = '.rst'
48
49 # The encoding of source files.
50 #source_encoding = 'utf-8-sig'
51
52 # The master toctree document.
53 master_doc = 'index'
54
55 # General information about the project.
56 project = u'Philo'
57 copyright = u'2009-2012, iThink Software'
58
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
61 # built documents.
62 #
63 # The short X.Y version.
64 from philo import VERSION
65 version = '.'.join([str(v) for v in VERSION])
66 # The full version, including alpha/beta/rc tags.
67 release = version
68
69 # The language for content autogenerated by Sphinx. Refer to documentation
70 # for a list of supported languages.
71 #language = None
72
73 # There are two options for replacing |today|: either, you set today to some
74 # non-false value, then it is used:
75 #today = ''
76 # Else, today_fmt is used as the format for a strftime call.
77 #today_fmt = '%B %d, %Y'
78
79 # List of patterns, relative to source directory, that match files and
80 # directories to ignore when looking for source files.
81 exclude_patterns = ['_build']
82
83 # The reST default role (used for this markup: `text`) to use for all documents.
84 #default_role = None
85
86 # If true, '()' will be appended to :func: etc. cross-reference text.
87 #add_function_parentheses = True
88
89 # If true, the current module name will be prepended to all description
90 # unit titles (such as .. function::).
91 #add_module_names = True
92
93 # If true, sectionauthor and moduleauthor directives will be shown in the
94 # output. They are ignored by default.
95 #show_authors = False
96
97 # The name of the Pygments (syntax highlighting) style to use.
98 pygments_style = 'sphinx'
99
100 # A list of ignored prefixes for module index sorting.
101 #modindex_common_prefix = []
102
103
104 # Autodoc config
105 autodoc_member_order = "bysource"
106
107
108 # -- Options for HTML output ---------------------------------------------------
109
110 # The theme to use for HTML and HTML Help pages.  See the documentation for
111 # a list of builtin themes.
112 html_theme = 'default'
113
114 # Theme options are theme-specific and customize the look and feel of a theme
115 # further.  For a list of options available for each theme, see the
116 # documentation.
117 #html_theme_options = {}
118
119 # Add any paths that contain custom themes here, relative to this directory.
120 #html_theme_path = []
121
122 # The name for this set of Sphinx documents.  If None, it defaults to
123 # "<project> v<release> documentation".
124 #html_title = None
125
126 # A shorter title for the navigation bar.  Default is the same as html_title.
127 #html_short_title = None
128
129 # The name of an image file (relative to this directory) to place at the top
130 # of the sidebar.
131 #html_logo = None
132
133 # The name of an image file (within the static path) to use as favicon of the
134 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
135 # pixels large.
136 #html_favicon = None
137
138 # Add any paths that contain custom static files (such as style sheets) here,
139 # relative to this directory. They are copied after the builtin static files,
140 # so a file named "default.css" will overwrite the builtin "default.css".
141 html_static_path = ['_static']
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 = {}
153
154 # Additional templates that should be rendered to pages, maps page names to
155 # template names.
156 #html_additional_pages = {}
157
158 # If false, no module index is generated.
159 #html_domain_indices = True
160
161 # If false, no index is generated.
162 #html_use_index = True
163
164 # If true, the index is split into individual pages for each letter.
165 #html_split_index = False
166
167 # If true, links to the reST sources are added to the pages.
168 #html_show_sourcelink = True
169
170 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
171 #html_show_sphinx = True
172
173 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
174 #html_show_copyright = True
175
176 # If true, an OpenSearch description file will be output, and all pages will
177 # contain a <link> tag referring to it.  The value of this option must be the
178 # base URL from which the finished HTML is served.
179 #html_use_opensearch = ''
180
181 # This is the file name suffix for HTML files (e.g. ".xhtml").
182 #html_file_suffix = None
183
184 # Output file base name for HTML help builder.
185 htmlhelp_basename = 'Philodoc'
186
187
188 # -- Options for LaTeX output --------------------------------------------------
189
190 # The paper size ('letter' or 'a4').
191 #latex_paper_size = 'letter'
192
193 # The font size ('10pt', '11pt' or '12pt').
194 #latex_font_size = '10pt'
195
196 # Grouping the document tree into LaTeX files. List of tuples
197 # (source start file, target name, title, author, documentclass [howto/manual]).
198 latex_documents = [
199   ('index', 'Philo.tex', u'Philo Documentation',
200    u'iThink Software', 'manual'),
201 ]
202
203 # The name of an image file (relative to this directory) to place at the top of
204 # the title page.
205 #latex_logo = None
206
207 # For "manual" documents, if this is true, then toplevel headings are parts,
208 # not chapters.
209 #latex_use_parts = False
210
211 # If true, show page references after internal links.
212 #latex_show_pagerefs = False
213
214 # If true, show URL addresses after external links.
215 #latex_show_urls = False
216
217 # Additional stuff for the LaTeX preamble.
218 #latex_preamble = ''
219
220 # Documents to append as an appendix to all manuals.
221 #latex_appendices = []
222
223 # If false, no module index is generated.
224 #latex_domain_indices = True
225
226
227 # -- Options for manual page output --------------------------------------------
228
229 # One entry per manual page. List of tuples
230 # (source start file, name, description, authors, manual section).
231 man_pages = [
232     ('index', 'philo', u'Philo Documentation',
233      [u'iThink Software'], 1)
234 ]
235
236 def skip_attribute_attrs(app, what, name, obj, skip, options):
237         if name in ("attribute_set", "get_attribute_mapper", "nodes"):
238                 return True
239         return skip
240
241 def setup(app):
242         app.connect('autodoc-skip-member', skip_attribute_attrs)
243         #app.connect('autodoc-process-signature', )