conf Namespace Reference

Functions
def	setup

Variables
tuple	on_readthedocs os.environ.get("READTHEDOCS", None)
string	project "Acts"
string	author "The Acts authors"
tuple	copyright
list	extensions
tuple	warnings_filter_config str(Path(__file__).parent / "known-warnings.txt")
	warnings_filter_silent True
dictionary	source_suffix
string	master_doc "index"
list	exclude_patterns ["_build", "api/api_stub.rst", "api/api_index.rst"]
string	primary_domain "cpp"
string	highlight_language "cpp"
	smartquotes True
	numfig True
list	myst_enable_extensions ["dollarmath", "colon_fence", "amsmath"]
int	myst_heading_anchors 3
int	linkcheck_retries 5
list	linkcheck_ignore
string	html_theme "sphinx_rtd_theme"
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
tuple	breathe_default_members
tuple	env os.environ.copy()
tuple	cwd Path(__file__)
string	api_index_target "api/api.rst"
	stdout subprocess.DEVNULL,

Function Documentation

def conf.setup

(

app

)

Definition at line 138 of file conf.py.

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

Variable Documentation

string conf.api_index_target "api/api.rst"

Definition at line 118 of file conf.py.

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

string conf.author "The Acts authors"

Definition at line 16 of file conf.py.

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

tuple conf.breathe_default_members

Initial value:

(
    "members",
    "undoc-members",
)

Definition at line 95 of file conf.py.

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

string conf.breathe_default_project "Acts"

Definition at line 89 of file conf.py.

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

dictionary conf.breathe_domain_by_extension

Initial value:

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

Definition at line 90 of file conf.py.

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

dictionary conf.breathe_projects

Initial value:

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

Definition at line 86 of file conf.py.

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

tuple conf.copyright

Initial value:

(
    f"2014–{datetime.date.today().year} CERN for the benefit of the Acts project"
)

Definition at line 17 of file conf.py.

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

conf.cwd Path(__file__)

Definition at line 104 of file conf.py.

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

Referenced by testing::internal::FilePath.GetCurrentDir().

conf.env os.environ.copy()

Definition at line 102 of file conf.py.

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

Referenced by testing::UnitTest.AddEnvironment(), testing::internal::posix.GetEnv(), Acts::OnnxRuntimeBase.OnnxRuntimeBase(), onnxSession(), and runRecCKFTracks().

list conf.exclude_patterns ["_build", "api/api_stub.rst", "api/api_index.rst"]

Definition at line 43 of file conf.py.

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

list conf.extensions

Initial value:

[
    "breathe",
    "myst_parser",
    "sphinx.ext.mathjax",
    "warnings_filter",
]

Definition at line 27 of file conf.py.

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

Referenced by Acts::Test.BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), ActsExamples::TrackFindingFromPrototrackAlgorithm.execute(), ActsExamples::AlignmentAlgorithm.execute(), ActsExamples::TrackFindingAlgorithm.execute(), Acts::KalmanFitter< propagator_t, traj_t >::Actor< parameters_t >.filter(), Acts::KalmanFitter< propagator_t, traj_t >::Actor< parameters_t >.reversedFilter(), and Acts::EventDataView3DTest.testMultiTrajectory().

string conf.highlight_language "cpp"

Definition at line 46 of file conf.py.

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

conf.html_copy_source False

Definition at line 80 of file conf.py.

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

list conf.html_css_files

Initial value:

[
    "custom.css",
]

Definition at line 77 of file conf.py.

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

string conf.html_logo "figures/acts_logo_white.svg"

Definition at line 73 of file conf.py.

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

conf.html_show_sourcelink False

Definition at line 81 of file conf.py.

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

conf.html_show_sphinx False

Definition at line 82 of file conf.py.

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

list conf.html_static_path

Initial value:

[
    "_static",
]

Definition at line 74 of file conf.py.

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

string conf.html_theme "sphinx_rtd_theme"

Definition at line 64 of file conf.py.

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

dictionary conf.html_theme_options

Initial value:

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

Definition at line 67 of file conf.py.

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

list conf.linkcheck_ignore

Initial value:

[
    r"https://doi.org/.*",
    r"https://cernvm.cern.ch/.*",
    r"https://tavianator.com/.*",
    r"http://eigen.tuxfamily.org.*",
    r"https://pythia.org.*",
]

Definition at line 54 of file conf.py.

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

int conf.linkcheck_retries 5

Definition at line 53 of file conf.py.

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

string conf.master_doc "index"

Definition at line 41 of file conf.py.

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

list conf.myst_enable_extensions ["dollarmath", "colon_fence", "amsmath"]

Definition at line 50 of file conf.py.

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

int conf.myst_heading_anchors 3

Definition at line 51 of file conf.py.

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

conf.numfig True

Definition at line 48 of file conf.py.

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

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

Definition at line 11 of file conf.py.

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

string conf.primary_domain "cpp"

Definition at line 45 of file conf.py.

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

string conf.project "Acts"

Definition at line 15 of file conf.py.

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

conf.smartquotes True

Definition at line 47 of file conf.py.

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

dictionary conf.source_suffix

Initial value:

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

Definition at line 37 of file conf.py.

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

conf.stdout subprocess.DEVNULL,

Definition at line 124 of file conf.py.

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

Referenced by testing::internal.ColoredPrintf(), testing::internal::UnitTestImpl.ConfigureXmlOutput(), eic_sphenix_fill_xq2(), EnterPassword(), Fail(), Packet_w1.gdump(), Packet_w2.gdump(), Packet_w4.gdump(), oncsSubevent_w1.gdump(), oncsSubevent_w2.gdump(), oncsSubevent_w4.gdump(), testing::internal.Int32FromGTestEnv(), testing::internal::UnitTestImpl.ListTestsMatchingFilter(), main(), mg_hexdump_connection(), testing::internal::PrettyUnitTestResultPrinter.OnEnvironmentsSetUpStart(), testing::internal::PrettyUnitTestResultPrinter.OnEnvironmentsTearDownStart(), testing::internal::PrettyUnitTestResultPrinter.OnTestCaseEnd(), testing::internal::PrettyUnitTestResultPrinter.OnTestCaseStart(), testing::internal::PrettyUnitTestResultPrinter.OnTestEnd(), testing::internal::PrettyUnitTestResultPrinter.OnTestIterationEnd(), testing::internal::PrettyUnitTestResultPrinter.OnTestIterationStart(), testing::internal::PrettyUnitTestResultPrinter.OnTestPartResult(), testing::internal::PrettyUnitTestResultPrinter.OnTestStart(), testing::internal.ParseInt32(), TSQLUrl.Print(), tinyxml2::XMLDocument.Print(), testing::internal.PrintTestPartResult(), testing::internal.ShouldShard(), testing::internal.TEST(), and testing::internal.WriteToShardStatusFileIfNeeded().

tuple conf.warnings_filter_config str(Path(__file__).parent / "known-warnings.txt")

Definition at line 34 of file conf.py.

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

conf.warnings_filter_silent True

Definition at line 35 of file conf.py.

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