Elgg  Version 3.0
conf.py
Go to the documentation of this file.
1 # -*- coding: utf-8 -*-
2 #
3 # Elgg documentation build configuration file, created by
4 # sphinx-quickstart on Sat Apr 13 14:31:27 2013.
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.insert(0, os.path.abspath('.'))
20 
21 # -- General configuration -----------------------------------------------------
22 
23 # If your documentation needs a minimal Sphinx version, state it here.
24 #needs_sphinx = '1.0'
25 
26 from sphinx.highlighting import lexers
27 from pygments.lexers.web import PhpLexer
28 
29 # Add any Sphinx extension module names here, as strings. They can be extensions
30 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
31 extensions = []
32 
33 # Add any paths that contain templates here, relative to this directory.
34 templates_path = ['_templates']
35 
36 # The suffix of source filenames.
37 source_suffix = '.rst'
38 
39 # The encoding of source files.
40 #source_encoding = 'utf-8-sig'
41 
42 # The master toctree document.
43 master_doc = 'index'
44 
45 # General information about the project.
46 project = u'Elgg'
47 copyright = u'2013, Various'
48 
49 # The version info for the project you're documenting, acts as replacement for
50 # |version| and |release|, also used in various other places throughout the
51 # built documents.
52 #
53 # The short X.Y version.
54 version = 'master'
55 # The full version, including alpha/beta/rc tags.
56 release = 'master'
57 
58 # The language for content autogenerated by Sphinx. Refer to documentation
59 # for a list of supported languages.
60 #language = None
61 
62 # There are two options for replacing |today|: either, you set today to some
63 # non-false value, then it is used:
64 #today = ''
65 # Else, today_fmt is used as the format for a strftime call.
66 #today_fmt = '%B %d, %Y'
67 
68 # List of patterns, relative to source directory, that match files and
69 # directories to ignore when looking for source files.
70 exclude_patterns = ['_build']
71 
72 # The reST default role (used for this markup: `text`) to use for all documents.
73 #default_role = None
74 
75 # If true, '()' will be appended to :func: etc. cross-reference text.
76 #add_function_parentheses = True
77 
78 # If true, the current module name will be prepended to all description
79 # unit titles (such as .. function::).
80 #add_module_names = True
81 
82 # If true, sectionauthor and moduleauthor directives will be shown in the
83 # output. They are ignored by default.
84 #show_authors = False
85 
86 # The name of the Pygments (syntax highlighting) style to use.
87 pygments_style = 'sphinx'
88 
89 # A list of ignored prefixes for module index sorting.
90 #modindex_common_prefix = []
91 
92 # If true, keep warnings as "system message" paragraphs in the built documents.
93 #keep_warnings = False
94 
95 
96 # -- Elgg customizations -------------------------------------------------------
97 
98 # Support parsing PHP out of <?php ?> by default
99 lexers['php'] = PhpLexer(startinline=True)
100 lexers['php-annotations'] = PhpLexer(startinline=True)
101 lexers['php-standalone'] = PhpLexer(startinline=True)
102 
103 # use PHP as the primary domain
104 primary_domain = 'php'
105 
106 # -- Options for HTML output ---------------------------------------------------
107 
108 # The theme to use for HTML and HTML Help pages. See the documentation for
109 # a list of builtin themes.
110 html_theme = 'default'
111 
112 # Theme options are theme-specific and customize the look and feel of a theme
113 # further. For a list of options available for each theme, see the
114 # documentation.
115 #html_theme_options = {}
116 
117 # Add any paths that contain custom themes here, relative to this directory.
118 html_theme_path = ["_themes"]
119 
120 # on_rtd is whether we are on readthedocs.org
121 on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
122 
123 if not on_rtd: # only import and set the theme if we're building docs locally
124  html_theme = 'elgg_rtd_theme'
125 
126 # The name for this set of Sphinx documents. If None, it defaults to
127 # "<project> v<release> documentation".
128 #html_title = None
129 
130 # A shorter title for the navigation bar. Default is the same as html_title.
131 #html_short_title = None
132 
133 # The name of an image file (relative to this directory) to place at the top
134 # of the sidebar.
135 #html_logo = None
136 
137 # The name of an image file (within the static path) to use as favicon of the
138 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
139 # pixels large.
140 html_favicon = '../views/default/graphics/favicon.ico'
141 
142 # Add any paths that contain custom static files (such as style sheets) here,
143 # relative to this directory. They are copied after the builtin static files,
144 # so a file named "default.css" will overwrite the builtin "default.css".
145 html_static_path = ['_static']
146 
147 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
148 # using the given strftime format.
149 #html_last_updated_fmt = '%b %d, %Y'
150 
151 # If true, SmartyPants will be used to convert quotes and dashes to
152 # typographically correct entities.
153 #html_use_smartypants = True
154 
155 # Custom sidebar templates, maps document names to template names.
156 #html_sidebars = {}
157 
158 # Additional templates that should be rendered to pages, maps page names to
159 # template names.
160 #html_additional_pages = {}
161 
162 # If false, no module index is generated.
163 #html_domain_indices = True
164 
165 # If false, no index is generated.
166 #html_use_index = True
167 
168 # If true, the index is split into individual pages for each letter.
169 #html_split_index = False
170 
171 # If true, links to the reST sources are added to the pages.
172 #html_show_sourcelink = True
173 
174 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
175 #html_show_sphinx = True
176 
177 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
178 #html_show_copyright = True
179 
180 # If true, an OpenSearch description file will be output, and all pages will
181 # contain a <link> tag referring to it. The value of this option must be the
182 # base URL from which the finished HTML is served.
183 #html_use_opensearch = ''
184 
185 # This is the file name suffix for HTML files (e.g. ".xhtml").
186 #html_file_suffix = None
187 
188 # Output file base name for HTML help builder.
189 htmlhelp_basename = 'Elggdoc'
190 
191 
192 # -- Options for LaTeX output --------------------------------------------------
193 
194 latex_elements = {
195 # The paper size ('letterpaper' or 'a4paper').
196 #'papersize': 'letterpaper',
197 
198 # The font size ('10pt', '11pt' or '12pt').
199 #'pointsize': '10pt',
200 
201 # Additional stuff for the LaTeX preamble.
202 #'preamble': '',
203 }
204 
205 # Grouping the document tree into LaTeX files. List of tuples
206 # (source start file, target name, title, author, documentclass [howto/manual]).
207 latex_documents = [
208  ('index', 'Elgg.tex', u'Elgg Documentation',
209  u'Various', 'manual'),
210 ]
211 
212 # The name of an image file (relative to this directory) to place at the top of
213 # the title page.
214 #latex_logo = None
215 
216 # For "manual" documents, if this is true, then toplevel headings are parts,
217 # not chapters.
218 #latex_use_parts = False
219 
220 # If true, show page references after internal links.
221 #latex_show_pagerefs = False
222 
223 # If true, show URL addresses after external links.
224 #latex_show_urls = False
225 
226 # Documents to append as an appendix to all manuals.
227 #latex_appendices = []
228 
229 # If false, no module index is generated.
230 #latex_domain_indices = True
231 
232 
233 # -- Options for manual page output --------------------------------------------
234 
235 # One entry per manual page. List of tuples
236 # (source start file, name, description, authors, manual section).
237 man_pages = [
238  ('index', 'elgg', u'Elgg Documentation',
239  [u'Various'], 1)
240 ]
241 
242 # If true, show URL addresses after external links.
243 #man_show_urls = False
244 
245 
246 # -- Options for Texinfo output ------------------------------------------------
247 
248 # Grouping the document tree into Texinfo files. List of tuples
249 # (source start file, target name, title, author,
250 # dir menu entry, description, category)
251 texinfo_documents = [
252  ('index', 'Elgg', u'Elgg Documentation',
253  u'Various', 'Elgg', 'One line description of project.',
254  'Miscellaneous'),
255 ]
256 
257 # Documents to append as an appendix to all manuals.
258 #texinfo_appendices = []
259 
260 # If false, no module index is generated.
261 #texinfo_domain_indices = True
262 
263 # How to display URL addresses: 'footnote', 'no', or 'inline'.
264 #texinfo_show_urls = 'footnote'
265 
266 # If true, do not generate a @detailmenu in the "Top" node's menu.
267 #texinfo_no_detailmenu = False
268 
269 
270 # -- Options for internationalization and localization -------------------------
271 
272 # See http://sphinx-doc.org/latest/intl.html for more information.
273 locale_dirs = ['locale/']
274 gettext_compact = True # Less translation templates, easier to handle.