conf Namespace Reference

Classes
class	Mock

Variables
	this_dir = dirname(abspath(__file__))
	root_path = abspath(pjoin(this_dir, '../'))
string	on_rtd = 'True'
	MOCK_MODULES
list	extensions
list	templates_path = ['_templates']
string	source_suffix = '.rst'
string	master_doc = 'index'
string	project = u'pyccl'
string	copyright = u'2018, LSST DESC'
string	author = u'LSST DESC'
string	version = u'1.0'
string	release = u'1.0'
	language = None
list	exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
string	pygments_style = 'sphinx'
bool	todo_include_todos = True
string	html_theme = "sphinx_rtd_theme"
list	html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
list	html_static_path = []
dictionary	html_sidebars
string	htmlhelp_basename = 'CoreCosmologyLibrarydoc'
dictionary	latex_elements
list	latex_documents
list	man_pages
list	texinfo_documents
dictionary	intersphinx_mapping = {'https://docs.python.org/': None}

Variable Documentation

string conf.author = u'LSST DESC'

Definition at line 81 of file conf.py.

string conf.copyright = u'2018, LSST DESC'

Definition at line 80 of file conf.py.

list conf.exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

Definition at line 102 of file conf.py.

list conf.extensions

Initial value:

= [
    'sphinx.ext.autodoc',
    'sphinx.ext.doctest',
    'sphinx.ext.intersphinx',
    'sphinx.ext.todo',
    'sphinx.ext.coverage',
    'sphinx.ext.ifconfig',
    'sphinx.ext.mathjax',
    'sphinx.ext.viewcode',
    'sphinx.ext.napoleon']

Definition at line 55 of file conf.py.

dictionary conf.html_sidebars

Initial value:

= {
    '**': [
        'about.html',
        'navigation.html',
        'relations.html',  # needs 'show_related': True theme option to display
        'searchbox.html',
        'donate.html',
    ]
}

Definition at line 136 of file conf.py.

list conf.html_static_path = []

Definition at line 129 of file conf.py.

string conf.html_theme = "sphinx_rtd_theme"

Definition at line 117 of file conf.py.

list conf.html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

Definition at line 118 of file conf.py.

string conf.htmlhelp_basename = 'CoreCosmologyLibrarydoc'

Definition at line 150 of file conf.py.

dictionary conf.intersphinx_mapping = {'https://docs.python.org/': None}

Definition at line 207 of file conf.py.

conf.language = None

Definition at line 97 of file conf.py.

list conf.latex_documents

Initial value:

= [
    (master_doc, 'CoreCosmologyLibrary.tex', u'Core Cosmology Library Documentation',
     u'LSST DESC', 'manual'),
]

Definition at line 176 of file conf.py.

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': '',

    # Latex figure (float) alignment
    #
    # 'figure_align': 'htbp',
}

Definition at line 155 of file conf.py.

list conf.man_pages

Initial value:

= [
    (master_doc, 'corecosmologylibrary', u'Core Cosmology Library Documentation',
     [author], 1)
]

Definition at line 186 of file conf.py.

string conf.master_doc = 'index'

Definition at line 76 of file conf.py.

conf.MOCK_MODULES

Definition at line 39 of file conf.py.

string conf.on_rtd = 'True'

Definition at line 27 of file conf.py.

string conf.project = u'pyccl'

Definition at line 79 of file conf.py.

string conf.pygments_style = 'sphinx'

Definition at line 105 of file conf.py.

string conf.release = u'1.0'

Definition at line 90 of file conf.py.

Referenced by Catch::ReusableStringStream.get().

conf.root_path = abspath(pjoin(this_dir, '../'))

Definition at line 23 of file conf.py.

string conf.source_suffix = '.rst'

Definition at line 73 of file conf.py.

list conf.templates_path = ['_templates']

Definition at line 67 of file conf.py.

list conf.texinfo_documents

Initial value:

= [
    (master_doc, 'CoreCosmologyLibrary', u'Core Cosmology Library Documentation',
     author, 'LSSTDESC', 'Routines for cosmological calculations.',
     'Miscellaneous'),
]

Definition at line 197 of file conf.py.

conf.this_dir = dirname(abspath(__file__))

Definition at line 22 of file conf.py.

bool conf.todo_include_todos = True

Definition at line 108 of file conf.py.

string conf.version = u'1.0'

Definition at line 88 of file conf.py.