SourceXtractorPlusPlus 0.21
SourceXtractor++, the next generation SExtractor
Loading...
Searching...
No Matches
Classes | Functions | Variables
conf Namespace Reference

Classes

class  ADSArxivStyle
 

Functions

 setup (app)
 
 _format_data (node, data)
 
 _format_list (list_, data)
 
 href2 (children, data)
 

Variables

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

Function Documentation

◆ _format_data()

conf._format_data ( node,
data )
protected

Definition at line 480 of file conf.py.

Referenced by _format_list().

◆ _format_list()

conf._format_list ( list_,
data )
protected

Definition at line 489 of file conf.py.

References _format_data().

Referenced by href2().

Here is the call graph for this function:

◆ href2()

conf.href2 ( children,
data )

Definition at line 493 of file conf.py.

References _format_list().

Here is the call graph for this function:

◆ setup()

conf.setup ( app)

Definition at line 181 of file conf.py.

Variable Documentation

◆ add_module_names

bool conf.add_module_names = False

Definition at line 135 of file conf.py.

◆ author

str conf.author = 'SourceXtractor++ team'

Definition at line 67 of file conf.py.

◆ autodoc_mock_imports

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

Definition at line 137 of file conf.py.

◆ bibtex_bibfiles

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

Definition at line 468 of file conf.py.

◆ copyright

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

Definition at line 66 of file conf.py.

◆ epub_author

str conf.epub_author = author

Definition at line 383 of file conf.py.

◆ epub_copyright

str conf.epub_copyright = copyright

Definition at line 385 of file conf.py.

◆ epub_exclude_files

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

Definition at line 433 of file conf.py.

◆ epub_publisher

str conf.epub_publisher = author

Definition at line 384 of file conf.py.

◆ epub_title

str conf.epub_title = project

Definition at line 382 of file conf.py.

◆ exclude_patterns

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

Definition at line 97 of file conf.py.

◆ extensions

list conf.extensions
Initial value:
1= [
2# 'sphinx.ext.intersphinx',
3# 'sphinx.ext.todo',
4 'sphinx.ext.mathjax',
5# 'sphinx.ext.ifconfig',
6 'sphinx.ext.autodoc',
7 'sphinx.ext.napoleon',
8 'sphinx.ext.autosummary',
9 'sphinx.ext.doctest',
10 'sphinx.ext.inheritance_diagram',
11 'sphinxcontrib.bibtex',
12 'sphinx.ext.githubpages'
13]

Definition at line 33 of file conf.py.

◆ filename

str conf.filename = 'sourcextractor'

Definition at line 65 of file conf.py.

◆ html_show_sourcelink

bool conf.html_show_sourcelink = False

Definition at line 236 of file conf.py.

◆ html_show_sphinx

bool conf.html_show_sphinx = False

Definition at line 240 of file conf.py.

◆ html_sidebars

dict conf.html_sidebars
Initial value:
1= {
2 '**': [
3 'relations.html', # needs 'show_related': True theme option to display
4 'searchbox.html',
5 ]
6}

Definition at line 195 of file conf.py.

◆ html_static_path

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

Definition at line 178 of file conf.py.

◆ html_theme

str conf.html_theme = 'sphinx_rtd_theme'

Definition at line 144 of file conf.py.

◆ html_theme_path

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

Definition at line 153 of file conf.py.

◆ htmlhelp_basename

str conf.htmlhelp_basename = filename + 'doc'

Definition at line 274 of file conf.py.

◆ intersphinx_mapping

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

Definition at line 465 of file conf.py.

◆ language

conf.language = None

Definition at line 83 of file conf.py.

◆ latex_documents

list conf.latex_documents
Initial value:
1= [
2 (master_doc, filename + '.tex', project + ' Documentation',
3 author, 'manual'),
4]

Definition at line 299 of file conf.py.

◆ latex_elements

dict conf.latex_elements
Initial value:
1= {
2 # The paper size ('letterpaper' or 'a4paper').
3 #
4'papersize': 'a4paper',
5
6 # The font size ('10pt', '11pt' or '12pt').
7 #
8 # 'pointsize': '10pt',
9
10 # Additional stuff for the LaTeX preamble.
11 #
12'preamble': '\\usepackage{amssymb}',
13
14 # Latex figure (float) alignment
15 #
16 # 'figure_align': 'htbp',
17}

Definition at line 278 of file conf.py.

◆ man_pages

list conf.man_pages
Initial value:
1= [
2 (master_doc, filename, project + ' Documentation',
3 author, 1)
4]

Definition at line 341 of file conf.py.

◆ master_doc

str conf.master_doc = 'index'

Definition at line 61 of file conf.py.

◆ new_version

conf.new_version = vers.parse("0.22")

Definition at line 477 of file conf.py.

◆ numfig

bool conf.numfig = True

Definition at line 130 of file conf.py.

◆ project

str conf.project = 'SourceXtractor++'

Definition at line 64 of file conf.py.

◆ pygments_style

str conf.pygments_style = 'sphinx'

Definition at line 119 of file conf.py.

◆ release

str conf.release = '1.0.0'

Definition at line 76 of file conf.py.

◆ source_suffix

str conf.source_suffix = '.rst'

Definition at line 54 of file conf.py.

◆ templates_path

list conf.templates_path = ['_templates']

Definition at line 48 of file conf.py.

◆ texinfo_documents

list conf.texinfo_documents
Initial value:
1= [
2 (master_doc, filename, project + ' Documentation',
3 author, project, 'One line description of project.',
4 'Miscellaneous'),
5]

Definition at line 356 of file conf.py.

◆ today_fmt

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

Definition at line 92 of file conf.py.

◆ todo_include_todos

bool conf.todo_include_todos = True

Definition at line 128 of file conf.py.

◆ version

str conf.version = '1.0.0'

Definition at line 74 of file conf.py.