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