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