Slicer  5.3
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
Variables
conf Namespace Reference

Variables

string author = 'Slicer Community'
 
list autodoc_mock_imports
 
string copyright = '2020, Slicer Community'
 
 docsfolder = os.path.dirname(__file__)
 
 dom = ET.parse(os.path.join(root, name))
 
list exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '_moduledescriptions']
 
list excludenames
 
 exist_ok
 
list extensions
 
list html_css_files
 
string html_logo = '_static/images/3D-Slicer-Mark.png'
 
list html_static_path = ['_static']
 
string html_theme = 'default'
 
dictionary html_theme_options
 
list html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
string htmlhelp_basename = '3DSlicerdoc'
 
list inputpaths
 
 language = None
 
list latex_documents
 
dictionary latex_elements
 
list man_pages
 
string master_doc = 'index'
 
list myst_enable_extensions
 
int myst_heading_anchors = 6
 
dictionary notfound_context
 
string on_rtd = 'True'
 
 outpath = os.path.join(docsfolder, "_moduledescriptions")
 
string project = '3D Slicer'
 
string pygments_style = 'sphinx'
 
string release = ''
 
 rst_prolog = open('global.rst.in').read()
 
list source_suffix = ['.rst', '.md']
 
list suppress_warnings
 
list templates_path = ['_templates']
 
list texinfo_documents
 
bool todo_include_todos = False
 
string version = ''
 

Variable Documentation

◆ author

string conf.author = 'Slicer Community'

Definition at line 78 of file conf.py.

◆ autodoc_mock_imports

list conf.autodoc_mock_imports
Initial value:
1 = [
2  "ctk",
3  "qt",
4  "vtk",
5 ]

Definition at line 49 of file conf.py.

◆ copyright

string conf.copyright = '2020, Slicer Community'

Definition at line 77 of file conf.py.

◆ docsfolder

conf.docsfolder = os.path.dirname(__file__)

Definition at line 250 of file conf.py.

◆ dom

conf.dom = ET.parse(os.path.join(root, name))

Definition at line 290 of file conf.py.

◆ exclude_patterns

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

Definition at line 99 of file conf.py.

◆ excludenames

list conf.excludenames
Initial value:
1 = [
2  'CLIROITest.xml',
3  'TestGridTransformRegistration.xml',
4  'DiffusionTensorTest.xml',
5 ]

Definition at line 260 of file conf.py.

◆ exist_ok

conf.exist_ok

Definition at line 268 of file conf.py.

◆ extensions

list conf.extensions
Initial value:
1 = [
2  'sphinx.ext.autodoc',
3  'myst_parser',
4  'sphinx_markdown_tables',
5  'notfound.extension', # Show a better 404 page when an invalid address is entered
6 ]

Definition at line 36 of file conf.py.

◆ html_css_files

list conf.html_css_files
Initial value:
1 = [
2  'css/custom.css',
3 ]

Definition at line 158 of file conf.py.

◆ html_logo

string conf.html_logo = '_static/images/3D-Slicer-Mark.png'

Definition at line 133 of file conf.py.

◆ html_static_path

list conf.html_static_path = ['_static']

Definition at line 154 of file conf.py.

◆ html_theme

string conf.html_theme = 'default'

Definition at line 140 of file conf.py.

◆ html_theme_options

dictionary conf.html_theme_options
Initial value:
1 = {
2  # Toc options
3  'includehidden': False,
4 }

Definition at line 146 of file conf.py.

◆ html_theme_path

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

Definition at line 227 of file conf.py.

◆ htmlhelp_basename

string conf.htmlhelp_basename = '3DSlicerdoc'

Definition at line 165 of file conf.py.

◆ inputpaths

list conf.inputpaths
Initial value:
1 = [
2  os.path.join(docsfolder, "../Modules/CLI"),
3  os.path.join(docsfolder, "_extracli"),
4 ]

Definition at line 253 of file conf.py.

◆ language

conf.language = None

Definition at line 94 of file conf.py.

◆ latex_documents

list conf.latex_documents
Initial value:
1 = [
2  (master_doc, '3DSlicer.tex', '3D Slicer Documentation',
3  'Slicer Community', 'manual'),
4 ]

Definition at line 191 of file conf.py.

◆ latex_elements

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

Definition at line 170 of file conf.py.

◆ man_pages

list conf.man_pages
Initial value:
1 = [
2  (master_doc, '3Dslicer', '3D Slicer Documentation',
3  [author], 1)
4 ]

Definition at line 201 of file conf.py.

◆ master_doc

string conf.master_doc = 'index'

Definition at line 73 of file conf.py.

◆ myst_enable_extensions

list conf.myst_enable_extensions
Initial value:
1 = [
2  "colon_fence", # Allow code fence using ::: (see https://myst-parser.readthedocs.io/en/latest/using/syntax-optional.html#syntax-colon-fence)
3  "linkify", # Allow automatic creation of links from URLs (it is sufficient to write https://google.com instead of <https://google.com>)
4 ]

Definition at line 55 of file conf.py.

◆ myst_heading_anchors

int conf.myst_heading_anchors = 6

Definition at line 62 of file conf.py.

◆ notfound_context

dictionary conf.notfound_context
Initial value:
1 = {
2  'title': 'Page Not Found',
3  'body': ,
4 }

Definition at line 113 of file conf.py.

◆ on_rtd

string conf.on_rtd = 'True'

Definition at line 222 of file conf.py.

◆ outpath

conf.outpath = os.path.join(docsfolder, "_moduledescriptions")

Definition at line 267 of file conf.py.

◆ project

string conf.project = '3D Slicer'

Definition at line 76 of file conf.py.

◆ pygments_style

string conf.pygments_style = 'sphinx'

Definition at line 123 of file conf.py.

◆ release

string conf.release = ''

Definition at line 87 of file conf.py.

◆ rst_prolog

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

Definition at line 129 of file conf.py.

◆ source_suffix

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

Definition at line 70 of file conf.py.

◆ suppress_warnings

list conf.suppress_warnings
Initial value:
1 = [
2  # Since we split the "script_repository.md" into smaller documents combined using
3  # the "include" directive, we ignore warnings like "Document headings start at H2, not H1"
4  "myst.header",
5 ]

Definition at line 43 of file conf.py.

◆ templates_path

list conf.templates_path = ['_templates']

Definition at line 65 of file conf.py.

◆ texinfo_documents

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

Definition at line 212 of file conf.py.

◆ todo_include_todos

bool conf.todo_include_todos = False

Definition at line 126 of file conf.py.

◆ version

string conf.version = ''

Definition at line 85 of file conf.py.