conf Namespace Reference

Classes
class	ADSArxivStyle

Functions
def	setup (app)

Variables
list	extensions
list	templates_path = ['_templates']
string	source_suffix = '.rst'
string	master_doc = 'index'
string	project = u'SourceXtractor++'
string	filename = 'sourcextractor'
string	copyright = u'2019, GenevaU/LMU/CNRS/SorbonneU'
string	author = u'SourceXtractor++ team'
string	version = '1.0.0'
string	release = '1.0.0'
	language = None
string	today = 'Thu Jan 31 2019'
list	exclude_patterns = ['global.rst','keys.rst','roles.rst']
string	pygments_style = 'sphinx'
bool	todo_include_todos = True
bool	numfig = True
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
bool	html_show_sourcelink = False
bool	html_show_sphinx = False
string	htmlhelp_basename = filename + 'doc'
dictionary	latex_elements
list	latex_documents
string	latex_show_urls = 'footnote'
list	man_pages
list	texinfo_documents
string	epub_title = project
string	epub_author = author
string	epub_publisher = author
string	epub_copyright = copyright
list	epub_exclude_files = ['search.html']
dictionary	intersphinx_mapping = {'https://docs.python.org/': None}

Function Documentation

setup()

def conf.setup

(

app

)

Definition at line 172 of file conf.py.

Variable Documentation

author

string conf.author = u'SourceXtractor++ team'

Definition at line 65 of file conf.py.

copyright

string conf.copyright = u'2019, GenevaU/LMU/CNRS/SorbonneU'

Definition at line 64 of file conf.py.

epub_author

string conf.epub_author = author

Definition at line 374 of file conf.py.

epub_copyright

string conf.epub_copyright = copyright

Definition at line 376 of file conf.py.

epub_exclude_files

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

Definition at line 424 of file conf.py.

epub_publisher

string conf.epub_publisher = author

Definition at line 375 of file conf.py.

epub_title

string conf.epub_title = project

Definition at line 373 of file conf.py.

exclude_patterns

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

Definition at line 95 of file conf.py.

extensions

list conf.extensions

Initial value:

=  [
#   'sphinx.ext.intersphinx',
#   'sphinx.ext.todo',
    'sphinx.ext.mathjax',
#    'sphinx.ext.ifconfig',
#    'sphinx.ext.viewcode',
    'sphinxcontrib.bibtex',
    'sphinx.ext.githubpages'
]

Definition at line 35 of file conf.py.

filename

string conf.filename = 'sourcextractor'

Definition at line 63 of file conf.py.

Referenced by SourceXtractor::FitsImageSource< T >.FitsImageSource(), SourceXtractor::CheckImages.getApertureImage(), SourceXtractor::CheckImages.getAutoApertureImage(), SourceXtractor::FitsFileManager.getFitsFile(), SourceXtractor::CheckImages.getModelFittingImage(), SourceXtractor::CheckImages.getPsfImage(), SourceXtractor::PythonConfig.initialize(), SourceXtractor::ExternalFlagConfig.initialize(), SourceXtractor::SegmentationConfig.loadASCIIFilter(), SourceXtractor::SegmentationConfig.loadFilter(), SourceXtractor::SegmentationConfig.loadFITSFilter(), SourceXtractor::FitsFile.loadHeadFile(), TestImage.loadSourcesFromCatalog(), TestImage.loadSourcesFromFile(), TestImage.mainMethod(), SourceXtractor::FitsWriter.newImage(), SourceXtractor::PythonConfig.preInitialize(), SourceXtractor::ExternalFlagConfig.preInitialize(), SourceXtractor.pyToElementsException(), SourceXtractor::FitsReader< T >.readFile(), SourceXtractor::PsfPluginConfig.readPsf(), SourceXtractor::PythonInterpreter.runFile(), SourceXtractor::CheckImages.saveImages(), TestImage.saveSources(), and SourceXtractor::FitsWriter.writeFile().

html_show_sourcelink

bool conf.html_show_sourcelink = False

Definition at line 227 of file conf.py.

html_show_sphinx

bool conf.html_show_sphinx = False

Definition at line 231 of file conf.py.

html_sidebars

dictionary conf.html_sidebars

Initial value:

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

Definition at line 186 of file conf.py.

html_static_path

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

Definition at line 169 of file conf.py.

html_theme

string conf.html_theme = 'sphinx_rtd_theme'

Definition at line 135 of file conf.py.

html_theme_path

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

Definition at line 144 of file conf.py.

htmlhelp_basename

string conf.htmlhelp_basename = filename + 'doc'

Definition at line 265 of file conf.py.

intersphinx_mapping

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

Definition at line 456 of file conf.py.

language

conf.language = None

Definition at line 81 of file conf.py.

latex_documents

list conf.latex_documents

Initial value:

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

Definition at line 290 of file conf.py.

latex_elements

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 269 of file conf.py.

latex_show_urls

string conf.latex_show_urls = 'footnote'

Definition at line 311 of file conf.py.

man_pages

list conf.man_pages

Initial value:

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

Definition at line 332 of file conf.py.

master_doc

string conf.master_doc = 'index'

Definition at line 59 of file conf.py.

numfig

bool conf.numfig = True

Definition at line 128 of file conf.py.

project

string conf.project = u'SourceXtractor++'

Definition at line 62 of file conf.py.

pygments_style

string conf.pygments_style = 'sphinx'

Definition at line 117 of file conf.py.

release

string conf.release = '1.0.0'

Definition at line 74 of file conf.py.

source_suffix

string conf.source_suffix = '.rst'

Definition at line 52 of file conf.py.

templates_path

list conf.templates_path = ['_templates']

Definition at line 46 of file conf.py.

texinfo_documents

list conf.texinfo_documents

Initial value:

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

Definition at line 347 of file conf.py.

today

string conf.today = 'Thu Jan 31 2019'

Definition at line 86 of file conf.py.

todo_include_todos

bool conf.todo_include_todos = True

Definition at line 126 of file conf.py.

version

string conf.version = '1.0.0'

Definition at line 72 of file conf.py.