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