Functions
def	setup

Variables
tuple	on_readthedocs os.environ.get("READTHEDOCS", None)

string	project "Acts"

string	author "The Acts authors"

string	copyright "2014–2020 CERN for the benefit of the Acts project"

list	extensions

dictionary	source_suffix

string	master_doc "index"

list	exclude_patterns

string	primary_domain "cpp"

string	highlight_language "cpp"

	smartquotes True

	numfig True

string	html_theme "sphinx_rtd_theme"

list	html_theme_path

dictionary	html_theme_options

string	html_logo "figures/acts_logo_white.svg"

list	html_static_path

list	html_css_files

	html_copy_source False

	html_show_sourcelink False

	html_show_sphinx False

dictionary	breathe_projects

string	breathe_default_project "Acts"

dictionary	breathe_domain_by_extension

list	breathe_default_members

dictionary	exhale_args

string	version u''

string	release u'0.00.01'

list	templates_path ['_templates']

	language None

	pygments_style None

string	htmlhelp_basename 'DelphesEicBuilder'

dictionary	latex_elements

list	latex_documents

list	man_pages

list	texinfo_documents

	epub_title project

list	epub_exclude_files ['search.html']

Function Documentation

def conf.setup ( app )

Definition at line 112 of file conf.py.

View newest version in sPHENIX GitHub at line 112 of file conf.py

Referenced by rcdaqEventiterator.rcdaqEventiterator().

Here is the caller graph for this function:

Variable Documentation

string conf.author "The Acts authors"

Definition at line 14 of file conf.py.

View newest version in sPHENIX GitHub at line 14 of file conf.py

list conf.breathe_default_members

Initial value:

 [
     "members",
     "undoc-members",
 ]

Definition at line 81 of file conf.py.

View newest version in sPHENIX GitHub at line 81 of file conf.py

string conf.breathe_default_project "Acts"

Definition at line 75 of file conf.py.

View newest version in sPHENIX GitHub at line 75 of file conf.py

dictionary conf.breathe_domain_by_extension

Initial value:

 {
     "cpp": "cpp",
     "hpp": "cpp",
     "ipp": "cpp",
 }

Definition at line 76 of file conf.py.

View newest version in sPHENIX GitHub at line 76 of file conf.py

dictionary conf.breathe_projects

Initial value:

 {
     "Acts": "_build/doxygen-xml",
 }

Definition at line 72 of file conf.py.

View newest version in sPHENIX GitHub at line 72 of file conf.py

string conf.copyright "2014–2020 CERN for the benefit of the Acts project"

Definition at line 15 of file conf.py.

View newest version in sPHENIX GitHub at line 15 of file conf.py

list conf.epub_exclude_files ['search.html']

Definition at line 183 of file conf.py.

View newest version in sPHENIX GitHub at line 183 of file conf.py

conf.epub_title project

Definition at line 171 of file conf.py.

View newest version in sPHENIX GitHub at line 171 of file conf.py

list conf.exclude_patterns

Initial value:

 [
     "_build",
 ]

Definition at line 33 of file conf.py.

View newest version in sPHENIX GitHub at line 33 of file conf.py

dictionary conf.exhale_args

Initial value:

 {
     "containmentFolder": "api",
     "rootFileName": "api.rst",
     "rootFileTitle": "API",
     "createTreeView": True,
     "exhaleUseDoxyfile": True,
     # note: OUTPUT_DIRECTORY in Doxyfile must match breathe default project path
     # note: this must match STRIP_FROM_PATH in Doxyfile
     "doxygenStripFromPath": "..",
 }

Definition at line 88 of file conf.py.

View newest version in sPHENIX GitHub at line 88 of file conf.py

list conf.extensions

Initial value:

 [
     "breathe",
     "recommonmark",
     "sphinx.ext.mathjax",
     "sphinx_markdown_tables",
 ]

Definition at line 21 of file conf.py.

View newest version in sPHENIX GitHub at line 21 of file conf.py

string conf.highlight_language "cpp"

Definition at line 38 of file conf.py.

View newest version in sPHENIX GitHub at line 38 of file conf.py

conf.html_copy_source False

Definition at line 66 of file conf.py.

View newest version in sPHENIX GitHub at line 66 of file conf.py

list conf.html_css_files

Initial value:

 [
     "custom.css",
 ]

Definition at line 63 of file conf.py.

View newest version in sPHENIX GitHub at line 63 of file conf.py

string conf.html_logo "figures/acts_logo_white.svg"

Definition at line 59 of file conf.py.

View newest version in sPHENIX GitHub at line 59 of file conf.py

conf.html_show_sourcelink False

Definition at line 67 of file conf.py.

View newest version in sPHENIX GitHub at line 67 of file conf.py

conf.html_show_sphinx False

Definition at line 68 of file conf.py.

View newest version in sPHENIX GitHub at line 68 of file conf.py

list conf.html_static_path

Initial value:

 [
     "_static",
 ]

Definition at line 60 of file conf.py.

View newest version in sPHENIX GitHub at line 60 of file conf.py

string conf.html_theme "sphinx_rtd_theme"

Definition at line 48 of file conf.py.

View newest version in sPHENIX GitHub at line 48 of file conf.py

dictionary conf.html_theme_options

Initial value:

 {
     "collapse_navigation": False,
     "navigation_depth": 2,
     "prev_next_buttons_location": None,  # no prev/next links
     "style_external_links": True,
 }

Definition at line 53 of file conf.py.

View newest version in sPHENIX GitHub at line 53 of file conf.py

list conf.html_theme_path

Initial value:

 [
         sphinx_rtd_theme.get_html_theme_path(),
     ]

Definition at line 49 of file conf.py.

View newest version in sPHENIX GitHub at line 49 of file conf.py

string conf.htmlhelp_basename 'DelphesEicBuilder'

Definition at line 114 of file conf.py.

View newest version in sPHENIX GitHub at line 114 of file conf.py

conf.language None

Definition at line 71 of file conf.py.

View newest version in sPHENIX GitHub at line 71 of file conf.py

list conf.latex_documents

Initial value:

 [
     (master_doc, 'DelphesEIC.tex', u'Delphes EIC Documentation',
      u'Miguel Arratia, Stephen Sekula', 'manual'),
 ]

Definition at line 140 of file conf.py.

View newest version in sPHENIX GitHub at line 140 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 119 of file conf.py.

View newest version in sPHENIX GitHub at line 119 of file conf.py

list conf.man_pages

Initial value:

 [
     (master_doc, 'delphes-eic', u'Delphes EIC',
      [author], 1)
 ]

Definition at line 150 of file conf.py.

View newest version in sPHENIX GitHub at line 150 of file conf.py

string conf.master_doc "index"

Definition at line 31 of file conf.py.

View newest version in sPHENIX GitHub at line 31 of file conf.py

conf.numfig True

Definition at line 40 of file conf.py.

View newest version in sPHENIX GitHub at line 40 of file conf.py

tuple conf.on_readthedocs os.environ.get("READTHEDOCS", None)

Definition at line 9 of file conf.py.

View newest version in sPHENIX GitHub at line 9 of file conf.py

string conf.primary_domain "cpp"

Definition at line 37 of file conf.py.

View newest version in sPHENIX GitHub at line 37 of file conf.py

string conf.project "Acts"

Definition at line 13 of file conf.py.

View newest version in sPHENIX GitHub at line 13 of file conf.py

conf.pygments_style None

Definition at line 79 of file conf.py.

View newest version in sPHENIX GitHub at line 79 of file conf.py

string conf.release u'0.00.01'

Definition at line 29 of file conf.py.

View newest version in sPHENIX GitHub at line 29 of file conf.py

Referenced by G4GDMLReadStructure.AssemblyRead(), Acts::detail.updateSingleStepSize(), Acts::Test::PropagatorState::Stepper.updateStepSize(), Acts::StraightLineStepper.updateStepSize(), Acts::EigenStepper< bfield_t, extensionlist_t, auctioneer_t >.updateStepSize(), Acts::AtlasStepper< bfield_t >.updateStepSize(), G4GDMLReadStructure.VolumeRead(), and PHG4GDMLWrite.Write().

conf.smartquotes True

Definition at line 39 of file conf.py.

View newest version in sPHENIX GitHub at line 39 of file conf.py

string conf.source_suffix

Initial value:

 {
     ".rst": "restructuredtext",
     ".md": "markdown",
 }

Definition at line 27 of file conf.py.

View newest version in sPHENIX GitHub at line 27 of file conf.py

list conf.templates_path ['_templates']

Definition at line 55 of file conf.py.

View newest version in sPHENIX GitHub at line 55 of file conf.py

list conf.texinfo_documents

Initial value:

 [
     (master_doc, 'delphes-eic', u'Delphes 4 EIC Documentation',
      author, 'delphes-eic', 'One line description of project.',
      'Miscellaneous'),
 ]

Definition at line 161 of file conf.py.

View newest version in sPHENIX GitHub at line 161 of file conf.py

string conf.version u''

Definition at line 27 of file conf.py.

View newest version in sPHENIX GitHub at line 27 of file conf.py

Referenced by adjustFrameDataLength(), adjustFrameErrorLength(), adjustFrameHistoryLength(), adjustPacketDataLength(), adjustPacketDebugLength(), adjustPacketErrorLength(), checkFrameHdrVersion(), currentFrameHdr(), currentPacket(), emptyPacket(), findFrameAlignBlock(), findFrameErrorStart(), findFrameHistoryStart(), findNextError(), findPacketDataDescr(), findPacketDataEnd(), findPacketDebugStart(), findPacketErrorStart(), getAlignBlock(), getFrameAlignLength(), getFrameDataLength(), getFrameDataType(), getFrameErrorLength(), getFrameHdrVersion(), getFrameHistoryLength(), getFramePadding(), getFrameSourceId(), getFrameStatus(), getFrameType(), EicGeoParData.GetGeometryFileName(), getHistoryEntry(), getHistorySourceIndex(), getHistoryStage(), getHistoryStatus(), getPacketDataDescrLength(), getPacketDataLength(), getPacketDebugLength(), getPacketEndianism(), getPacketErrorLength(), getPacketId(), getPacketNumErrors(), getPacketPadding(), getPacketStatus(), getPacketStructure(), PHTimeServer.insert_new(), PHTimeServer.insert_new_single_shot(), Acts::Sycl.listPlatforms(), makePacketHdr(), Acts::Sycl::DeviceSelector.operator()(), orFrameStatus(), orPacketStatus(), FairDetParRootFileIo.read(), setAlignBlock(), setDataType(), setFrameAlignLength(), setFrameErrorLength(), setFrameHistoryLength(), setFramePadding(), setFrameStatus(), setFrameType(), setPacketDataDescrLength(), setPacketDebugLenth(), setPacketEndianism(), setPacketErrorLength(), setPacketId(), setPacketPadding(), setPacketStatus(), setPacketStructure(), setSourceId(), validFrameMark(), validPacketHdr(), and FairGenericParAsciiFileIo.writeGenericSet().

Functions

Variables

Function Documentation

Variable Documentation