conf Namespace Reference

Functions
	_generatemd (dom, docsfolder, outpath, xslt, suffix)

Variables
str	author = 'Slicer Community'
list	autodoc_mock_imports
str	copyright = f'{date.today().year}, 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
str	html_logo = '_static/images/3D-Slicer-Mark.png'
list	html_static_path = ['_static']
str	html_theme = 'default'
dict	html_theme_options
list	html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
str	htmlhelp_basename = '3DSlicerdoc'
list	inputpaths
list	latex_documents
dict	latex_elements
list	man_pages
str	master_doc = 'index'
bool	myst_dmath_allow_labels = True
list	myst_enable_extensions
int	myst_heading_anchors = 6
dict	notfound_context
str	on_rtd = 'True'
	outpath = os.path.join(docsfolder, "_moduledescriptions")
str	project = '3D Slicer'
str	pygments_style = 'sphinx'
str	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
str	version = ''

Function Documentation

_generatemd()

conf._generatemd ( dom, docsfolder, outpath, xslt, suffix )

protected

Helper function to create markdown file from CLI module description XML file using XSLT

Definition at line 273 of file conf.py.

Variable Documentation

author

str conf.author = 'Slicer Community'

Definition at line 84 of file conf.py.

autodoc_mock_imports

list conf.autodoc_mock_imports

Initial value:

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

Definition at line 49 of file conf.py.

copyright

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

Definition at line 83 of file conf.py.

docsfolder

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

Definition at line 249 of file conf.py.

dom

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

Definition at line 289 of file conf.py.

exclude_patterns

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

Definition at line 98 of file conf.py.

excludenames

list conf.excludenames

Initial value:

=  [
    'CLIROITest.xml',
    'TestGridTransformRegistration.xml',
    'DiffusionTensorTest.xml',
]

Definition at line 259 of file conf.py.

exist_ok

conf.exist_ok

Definition at line 267 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
]

Definition at line 36 of file conf.py.

html_css_files

list conf.html_css_files

Initial value:

=  [
    'css/custom.css',
]

Definition at line 157 of file conf.py.

html_logo

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

Definition at line 132 of file conf.py.

html_static_path

list conf.html_static_path = ['_static']

Definition at line 153 of file conf.py.

html_theme

str conf.html_theme = 'default'

Definition at line 139 of file conf.py.

html_theme_options

dict conf.html_theme_options

Initial value:

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

Definition at line 145 of file conf.py.

html_theme_path

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

Definition at line 226 of file conf.py.

htmlhelp_basename

str conf.htmlhelp_basename = '3DSlicerdoc'

Definition at line 164 of file conf.py.

inputpaths

list conf.inputpaths

Initial value:

=  [
    os.path.join(docsfolder, "../Modules/CLI"),
    os.path.join(docsfolder, "_extracli"),
]

Definition at line 252 of file conf.py.

latex_documents

list conf.latex_documents

Initial value:

=  [
    (master_doc, '3DSlicer.tex', '3D Slicer Documentation',
     'Slicer Community', 'manual'),
]

Definition at line 190 of file conf.py.

latex_elements

dict 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 169 of file conf.py.

man_pages

list conf.man_pages

Initial value:

=  [
    (master_doc, '3Dslicer', '3D Slicer Documentation',
     [author], 1)
]

Definition at line 200 of file conf.py.

master_doc

str conf.master_doc = 'index'

Definition at line 79 of file conf.py.

myst_dmath_allow_labels

bool conf.myst_dmath_allow_labels = True

Definition at line 68 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 55 of file conf.py.

myst_heading_anchors

int conf.myst_heading_anchors = 6

Definition at line 65 of file conf.py.

notfound_context

dict conf.notfound_context

Initial value:

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

Definition at line 112 of file conf.py.

on_rtd

str conf.on_rtd = 'True'

Definition at line 221 of file conf.py.

outpath

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

Definition at line 266 of file conf.py.

project

str conf.project = '3D Slicer'

Definition at line 82 of file conf.py.

pygments_style

str conf.pygments_style = 'sphinx'

Definition at line 122 of file conf.py.

release

str conf.release = ''

Definition at line 93 of file conf.py.

rst_prolog

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

Definition at line 128 of file conf.py.

source_suffix

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

Definition at line 76 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 43 of file conf.py.

templates_path

list conf.templates_path = ['_templates']

Definition at line 71 of file conf.py.

texinfo_documents

list conf.texinfo_documents

Initial value:

=  [
    (master_doc, '3DSlicer', '3D Slicer Documentation',
     author, '3DSlicer', 'One line description of project.',
     'Miscellaneous'),
]

Definition at line 211 of file conf.py.

todo_include_todos

bool conf.todo_include_todos = False

Definition at line 125 of file conf.py.

version

str conf.version = ''

Definition at line 91 of file conf.py.