conf Namespace Reference

Functions
	_extract_slicer_xy_version (slicer_src_dir)
	_get_apidocs_doxygen_version ()

Variables
str	author = "Slicer Community"
list	autodoc_mock_imports
str	copyright = f"{date.today().year}, Slicer Community"
list	exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "_moduledescriptions"]
list	extensions
str	html_logo = "_static/images/3D-Slicer-Mark.png"
str	html_theme = "sphinx_rtd_theme"
dict	html_theme_options
str	master_doc = "index"
bool	myst_dmath_allow_labels = True
list	myst_enable_extensions
int	myst_heading_anchors = 6
dict	myst_url_schemes
dict	notfound_context
str	project = "3D Slicer"
str	pygments_style = "sphinx"
str	release = ""
	rst_prolog = open("global.rst.in").read()
str	slicerapidocs_url_scheme = "https://apidocs.slicer.org/" + _get_apidocs_doxygen_version() + "/{{path}}#{{fragment}}"
list	source_suffix = [".rst", ".md"]
list	suppress_warnings
list	templates_path = ["_templates"]
bool	todo_include_todos = False
str	version = ""

Function Documentation

_extract_slicer_xy_version()

conf._extract_slicer_xy_version ( slicer_src_dir )

protected

Given a Slicer source director, extract <major>.<minor> version
from top-level `CMakeLists.txt`.

Return a dictionary containing `major` and `minor` version components as strings

Definition at line 74 of file conf.py.

_get_apidocs_doxygen_version()

conf._get_apidocs_doxygen_version ( )

protected

Determine the Doxygen documentation version to use based on the Slicer version.

Return Doxygen version identifier (`v<major>.<minor>` for Stable, `main` for Preview)

Definition at line 105 of file conf.py.

Variable Documentation

author

str conf.author = "Slicer Community"

Definition at line 150 of file conf.py.

autodoc_mock_imports

list conf.autodoc_mock_imports

Initial value:

=  [
    "ctk",
    "qt",
    "vtk",
]

Definition at line 52 of file conf.py.

copyright

str conf.copyright = f"{date.today().year}, Slicer Community"

Definition at line 149 of file conf.py.

exclude_patterns

list conf.exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "_moduledescriptions"]

Definition at line 164 of file conf.py.

extensions

list conf.extensions

Initial value:

=  [
    "sphinx.ext.autodoc",
    "myst_parser",
    "sphinx_markdown_tables",
    "notfound.extension",  # Show a better 404 page when an invalid address is entered
    "sphinx_rtd_theme",
    "sphinx-jsonschema",
]

Definition at line 37 of file conf.py.

html_logo

str conf.html_logo = "_static/images/3D-Slicer-Mark.png"

Definition at line 198 of file conf.py.

html_theme

str conf.html_theme = "sphinx_rtd_theme"

Definition at line 205 of file conf.py.

html_theme_options

dict conf.html_theme_options

Initial value:

=  {
    # Toc options
    "includehidden": False,
}

Definition at line 211 of file conf.py.

master_doc

str conf.master_doc = "index"

Definition at line 145 of file conf.py.

myst_dmath_allow_labels

bool conf.myst_dmath_allow_labels = True

Definition at line 71 of file conf.py.

myst_enable_extensions

list conf.myst_enable_extensions

Initial value:

=  [
    "attrs_inline",  # Enable parsing of inline attributes (see https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#inline-attributes)
    "colon_fence",  # Allow code fence using ::: (see https://myst-parser.readthedocs.io/en/latest/using/syntax-optional.html#syntax-colon-fence)
    "dollarmath",  # Support syntax for inline and block math using `$...$` and `$$...$$`
    # (see https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#dollar-delimited-math)
    "linkify",  # Allow automatic creation of links from URLs (it is sufficient to write https://google.com instead of <https://google.com>)
]

Definition at line 58 of file conf.py.

myst_heading_anchors

int conf.myst_heading_anchors = 6

Definition at line 68 of file conf.py.

myst_url_schemes

dict conf.myst_url_schemes

Initial value:

=  {
    "http": None,
    "https": None,
    "mailto": None,
    "ftp": None,
    "slicerapidocs": slicerapidocs_url_scheme,
}

Definition at line 127 of file conf.py.

notfound_context

dict conf.notfound_context

Initial value:

=  {
    "title": "Page Not Found",
    "body": ,
}

Definition at line 178 of file conf.py.

project

str conf.project = "3D Slicer"

Definition at line 148 of file conf.py.

pygments_style

str conf.pygments_style = "sphinx"

Definition at line 188 of file conf.py.

release

str conf.release = ""

Definition at line 159 of file conf.py.

rst_prolog

conf.rst_prolog = open("global.rst.in").read()

Definition at line 194 of file conf.py.

slicerapidocs_url_scheme

str conf.slicerapidocs_url_scheme = "https://apidocs.slicer.org/" + _get_apidocs_doxygen_version() + "/{{path}}#{{fragment}}"

Definition at line 121 of file conf.py.

source_suffix

list conf.source_suffix = [".rst", ".md"]

Definition at line 142 of file conf.py.

suppress_warnings

list conf.suppress_warnings

Initial value:

=  [
    # Since we split the "script_repository.md" into smaller documents combined using
    # the "include" directive, we ignore warnings like "Document headings start at H2, not H1"
    "myst.header",
]

Definition at line 46 of file conf.py.

templates_path

list conf.templates_path = ["_templates"]

Definition at line 137 of file conf.py.

todo_include_todos

bool conf.todo_include_todos = False

Definition at line 191 of file conf.py.

version

str conf.version = ""

Definition at line 157 of file conf.py.