conf Namespace Reference

Classes
class	ADSArxivStyle

Functions
def	setup
def	_format_data
def	_format_list
def	href2

Variables
list	extensions
list	templates_path = ['_templates']
string	source_suffix = '.rst'
string	master_doc = 'index'
string	project = 'SourceXtractor++'
string	filename = 'sourcextractor'
string	copyright = '2019,2020,2021,2022 GenevaU/LMU/CNRS/SorbonneU'
string	author = 'SourceXtractor++ team'
string	version = '1.0.0'
string	release = '1.0.0'
	language = None
string	today_fmt = '%B %d, %Y'
list	exclude_patterns = ['global.rst','keys.rst','roles.rst']
string	pygments_style = 'sphinx'
	todo_include_todos = True
	numfig = True
	add_module_names = False
list	autodoc_mock_imports = ['.measurement_images', '_SourceXtractorPy']
string	html_theme = 'sphinx_rtd_theme'
list	html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
list	html_static_path = ['../theme']
dictionary	html_sidebars
	html_show_sourcelink = False
	html_show_sphinx = False
string	htmlhelp_basename = filename+'doc'
dictionary	latex_elements
list	latex_documents
list	man_pages
list	texinfo_documents
	epub_title = project
	epub_author = author
	epub_publisher = author
	epub_copyright = copyright
list	epub_exclude_files = ['search.html']
dictionary	intersphinx_mapping = {'https://docs.python.org/': None}
list	bibtex_bibfiles = ["references.bib"]
tuple	new_version = vers.parse(pybtex_version)

Function Documentation

def conf._format_data (   node,   data  )

private

Definition at line 480 of file conf.py.

Referenced by _format_list().

def conf._format_list (   list_,   data  )

private

Definition at line 489 of file conf.py.

References _format_data().

Referenced by href2().

Here is the call graph for this function:

def conf.href2	(		children,
			data
	)

Definition at line 493 of file conf.py.

References _format_list().

Here is the call graph for this function:

def conf.setup

(

app

)

Definition at line 181 of file conf.py.

Variable Documentation

conf.add_module_names = False

Definition at line 135 of file conf.py.

string conf.author = 'SourceXtractor++ team'

Definition at line 67 of file conf.py.

list conf.autodoc_mock_imports = ['.measurement_images', '_SourceXtractorPy']

Definition at line 137 of file conf.py.

list conf.bibtex_bibfiles = ["references.bib"]

Definition at line 468 of file conf.py.

string conf.copyright = '2019,2020,2021,2022 GenevaU/LMU/CNRS/SorbonneU'

Definition at line 66 of file conf.py.

conf.epub_author = author

Definition at line 383 of file conf.py.

conf.epub_copyright = copyright

Definition at line 385 of file conf.py.

list conf.epub_exclude_files = ['search.html']

Definition at line 433 of file conf.py.

conf.epub_publisher = author

Definition at line 384 of file conf.py.

conf.epub_title = project

Definition at line 382 of file conf.py.

list conf.exclude_patterns = ['global.rst','keys.rst','roles.rst']

Definition at line 97 of file conf.py.

list conf.extensions

Initial value:

= [
#   'sphinx.ext.intersphinx',
#   'sphinx.ext.todo',
    'sphinx.ext.mathjax',
#    'sphinx.ext.ifconfig',
    'sphinx.ext.autodoc',
    'sphinx.ext.napoleon',
    'sphinx.ext.autosummary',
    'sphinx.ext.doctest',
    'sphinx.ext.inheritance_diagram',
    'sphinxcontrib.bibtex',
    'sphinx.ext.githubpages'
]

Definition at line 33 of file conf.py.

string conf.filename = 'sourcextractor'

Definition at line 65 of file conf.py.

Referenced by SourceXtractor::AsciiOutput.AsciiOutput(), SourceXtractor::FitsImageSource.FitsImageSource(), SourceXtractor::CheckImages.getMeasurementApertureImage(), SourceXtractor::CheckImages.getMeasurementAutoApertureImage(), SourceXtractor::CheckImages.getMLDetectionImage(), SourceXtractor::CheckImages.getModelFittingImage(), SourceXtractor::CheckImages.getPsfImage(), SourceXtractor::PythonConfig.initialize(), SourceXtractor::ExternalFlagConfig.initialize(), SourceXtractor::SegmentationConfig.loadASCIIFilter(), TestImage.mainMethod(), SourceXtractor::FitsWriter.newImage(), SourceXtractor::PythonConfig.preInitialize(), SourceXtractor::PyFitsFile.PyFitsFile(), SourceXtractor::AssocModeConfig.readCatalogs(), SourceXtractor::FitsReader< T >.readFile(), SourceXtractor::PsfPluginConfig.readPsf(), SourceXtractor::CheckImages.saveImages(), and SourceXtractor::FitsWriter.writeFile().

conf.html_show_sourcelink = False

Definition at line 236 of file conf.py.

conf.html_show_sphinx = False

Definition at line 240 of file conf.py.

dictionary conf.html_sidebars

Initial value:

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

Definition at line 195 of file conf.py.

list conf.html_static_path = ['../theme']

Definition at line 178 of file conf.py.

string conf.html_theme = 'sphinx_rtd_theme'

Definition at line 144 of file conf.py.

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

Definition at line 153 of file conf.py.

string conf.htmlhelp_basename = filename+'doc'

Definition at line 274 of file conf.py.

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

Definition at line 465 of file conf.py.

conf.language = None

Definition at line 83 of file conf.py.

list conf.latex_documents

Initial value:

= [
    (master_doc, filename + '.tex', project + ' Documentation',
     author, 'manual'),
]

Definition at line 299 of file conf.py.

dictionary conf.latex_elements

Initial value:

= {
     # The paper size ('letterpaper' or 'a4paper').
     #
'papersize': 'a4paper',

     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',

     # Additional stuff for the LaTeX preamble.
     #
'preamble': '\\usepackage{amssymb}',

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

Definition at line 278 of file conf.py.

list conf.man_pages

Initial value:

= [
    (master_doc, filename, project + ' Documentation',
     author, 1)
]

Definition at line 341 of file conf.py.

string conf.master_doc = 'index'

Definition at line 61 of file conf.py.

tuple conf.new_version = vers.parse(pybtex_version)

Definition at line 477 of file conf.py.

conf.numfig = True

Definition at line 130 of file conf.py.

string conf.project = 'SourceXtractor++'

Definition at line 64 of file conf.py.

string conf.pygments_style = 'sphinx'

Definition at line 119 of file conf.py.

string conf.release = '1.0.0'

Definition at line 76 of file conf.py.

string conf.source_suffix = '.rst'

Definition at line 54 of file conf.py.

list conf.templates_path = ['_templates']

Definition at line 48 of file conf.py.

list conf.texinfo_documents

Initial value:

= [
    (master_doc, filename, project + ' Documentation',
     author, project, 'One line description of project.',
     'Miscellaneous'),
]

Definition at line 356 of file conf.py.

string conf.today_fmt = '%B %d, %Y'

Definition at line 92 of file conf.py.

conf.todo_include_todos = True

Definition at line 128 of file conf.py.

string conf.version = '1.0.0'

Definition at line 74 of file conf.py.