conf Namespace Reference

Variables
string	author = 'Slicer Community'
string	copyright = '2020, Slicer Community'
list	exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
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'
	language = None
list	latex_documents
dictionary	latex_elements
list	man_pages
string	master_doc = 'index'
dictionary	notfound_context
string	on_rtd = 'True'
string	project = '3D Slicer'
string	pygments_style = 'sphinx'
string	release = ''
	rst_prolog = open('global.rst.in', 'r').read()
list	source_suffix = ['.rst', '.md']
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 60 of file conf.py.

copyright

string conf.copyright = '2020, Slicer Community'

Definition at line 59 of file conf.py.

exclude_patterns

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

Definition at line 81 of file conf.py.

extensions

list conf.extensions

Initial value:

=  [
    'sphinx.ext.autodoc',
    'workaround_recommonmark_issue_191',
    'recommonmark',
    'sphinx_markdown_tables',
    'notfound.extension',  # Show a better 404 page when an invlid address is entered
]

Definition at line 38 of file conf.py.

html_css_files

list conf.html_css_files

Initial value:

=  [
    'css/custom.css',
]

Definition at line 141 of file conf.py.

html_logo

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

Definition at line 116 of file conf.py.

html_static_path

list conf.html_static_path = ['_static']

Definition at line 137 of file conf.py.

html_theme

string conf.html_theme = 'default'

Definition at line 123 of file conf.py.

html_theme_options

dictionary conf.html_theme_options

Initial value:

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

Definition at line 129 of file conf.py.

html_theme_path

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

Definition at line 210 of file conf.py.

htmlhelp_basename

string conf.htmlhelp_basename = '3DSlicerdoc'

Definition at line 148 of file conf.py.

language

conf.language = None

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

latex_elements

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

man_pages

list conf.man_pages

Initial value:

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

Definition at line 184 of file conf.py.

master_doc

string conf.master_doc = 'index'

Definition at line 55 of file conf.py.

notfound_context

dictionary conf.notfound_context

Initial value:

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

Definition at line 96 of file conf.py.

on_rtd

string conf.on_rtd = 'True'

Definition at line 205 of file conf.py.

project

string conf.project = '3D Slicer'

Definition at line 58 of file conf.py.

pygments_style

string conf.pygments_style = 'sphinx'

Definition at line 106 of file conf.py.

release

string conf.release = ''

Definition at line 69 of file conf.py.

rst_prolog

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

Definition at line 112 of file conf.py.

source_suffix

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

Definition at line 52 of file conf.py.

templates_path

list conf.templates_path = ['_templates']

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

todo_include_todos

bool conf.todo_include_todos = False

Definition at line 109 of file conf.py.

version

string conf.version = ''

Definition at line 67 of file conf.py.