conf Namespace Reference

Functions
def	setup (app)

Variables
list	extensions = []
list	templates_path = ['_templates']
string	source_suffix = '.rst'
string	master_doc = 'index'
string	project = u'Elgg'
string	copyright = u'2013, Various'
string	version = '1.12'
string	release = '1.12'
list	exclude_patterns = ['_build']
string	pygments_style = 'sphinx'
string	html_theme = 'elgg_rtd_theme'
list	html_theme_path = ["_themes"]
string	on_rtd = 'True'
string	html_favicon = '../_graphics/favicon.ico'
list	html_static_path = ['_static']
string	htmlhelp_basename = 'Elggdoc'
dictionary	latex_elements
list	latex_documents
list	man_pages
list	texinfo_documents
list	locale_dirs = ['locale/']
bool	gettext_compact = True

Function Documentation

setup()

def conf.setup

(

app

)

Definition at line 111 of file conf.py.

Variable Documentation

copyright

string conf.copyright = u'2013, Various'

Definition at line 44 of file conf.py.

exclude_patterns

list conf.exclude_patterns = ['_build']

Definition at line 67 of file conf.py.

extensions

list conf.extensions = []

Definition at line 28 of file conf.py.

gettext_compact

bool conf.gettext_compact = True

Definition at line 262 of file conf.py.

html_favicon

string conf.html_favicon = '../_graphics/favicon.ico'

Definition at line 128 of file conf.py.

html_static_path

list conf.html_static_path = ['_static']

Definition at line 133 of file conf.py.

html_theme

string conf.html_theme = 'elgg_rtd_theme'

Definition at line 97 of file conf.py.

html_theme_path

list conf.html_theme_path = ["_themes"]

Definition at line 105 of file conf.py.

htmlhelp_basename

string conf.htmlhelp_basename = 'Elggdoc'

Definition at line 177 of file conf.py.

latex_documents

list conf.latex_documents

Initial value:

=  [
  ('index', 'Elgg.tex', u'Elgg Documentation',
   u'Various', 'manual'),
]

Definition at line 195 of file conf.py.

latex_elements

dictionary conf.latex_elements

Initial value:

=  {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
 
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
 
# Additional stuff for the LaTeX preamble.
#'preamble': '',
}

Definition at line 182 of file conf.py.

locale_dirs

list conf.locale_dirs = ['locale/']

Definition at line 261 of file conf.py.

man_pages

list conf.man_pages

Initial value:

=  [
    ('index', 'elgg', u'Elgg Documentation',
     [u'Various'], 1)
]

Definition at line 225 of file conf.py.

master_doc

string conf.master_doc = 'index'

Definition at line 40 of file conf.py.

on_rtd

string conf.on_rtd = 'True'

Definition at line 108 of file conf.py.

project

string conf.project = u'Elgg'

Definition at line 43 of file conf.py.

pygments_style

string conf.pygments_style = 'sphinx'

Definition at line 84 of file conf.py.

release

string conf.release = '1.12'

Definition at line 53 of file conf.py.

source_suffix

string conf.source_suffix = '.rst'

Definition at line 34 of file conf.py.

templates_path

list conf.templates_path = ['_templates']

Definition at line 31 of file conf.py.

texinfo_documents

list conf.texinfo_documents

Initial value:

=  [
  ('index', 'Elgg', u'Elgg Documentation',
   u'Various', 'Elgg', 'One line description of project.',
   'Miscellaneous'),
]

Definition at line 239 of file conf.py.

version

string conf.version = '1.12'

Definition at line 51 of file conf.py.