conf Namespace Reference

Variables
list	extensions = []
list	templates_path = ['_templates']
string	source_suffix = '.rst'
string	master_doc = 'index'
string	project = 'c-template-REPLACEME'
string	copyright = '2020 c-template-REPLACEME'
string	author = 'c-template-REPLACEME'
string	version = ''
string	release = ''
	language = None
list	exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
string	pygments_style = 'sphinx'
bool	todo_include_todos = False
string	html_theme = 'alabaster'
list	html_static_path = []
dictionary	html_sidebars
string	htmlhelp_basename = 'c-template-REPLACEME-doc'
dictionary	latex_elements
list	latex_documents
list	man_pages = [(master_doc, 'c-template-REPLACEME', 'c-template-REPLACEME Documentation', [author], 1)]

Variable Documentation

author

string conf.author = 'c-template-REPLACEME'

Definition at line 50 of file conf.py.

copyright

string conf.copyright = '2020 c-template-REPLACEME'

Definition at line 49 of file conf.py.

exclude_patterns

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

Definition at line 71 of file conf.py.

extensions

list conf.extensions = []

Definition at line 33 of file conf.py.

html_sidebars

dictionary conf.html_sidebars

Initial value:

=  {
    '**': [
        'relations.html',  # needs 'show_related': True theme option to display
        'searchbox.html',
    ]
}

Definition at line 102 of file conf.py.

html_static_path

list conf.html_static_path = []

Definition at line 95 of file conf.py.

html_theme

string conf.html_theme = 'alabaster'

Definition at line 84 of file conf.py.

htmlhelp_basename

string conf.htmlhelp_basename = 'c-template-REPLACEME-doc'

Definition at line 112 of file conf.py.

language

conf.language = None

Definition at line 66 of file conf.py.

latex_documents

list conf.latex_documents

Initial value:

=  [
    (master_doc, 'c-template-REPLACEME.tex', 'c-template-REPLACEME Documentation',
     'c-template-REPLACEME. c-template-AUTHOR', 'manual'),
]

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

man_pages

list conf.man_pages = [(master_doc, 'c-template-REPLACEME', 'c-template-REPLACEME Documentation', [author], 1)]

Definition at line 146 of file conf.py.

master_doc

string conf.master_doc = 'index'

Definition at line 45 of file conf.py.

project

string conf.project = 'c-template-REPLACEME'

Definition at line 48 of file conf.py.

pygments_style

string conf.pygments_style = 'sphinx'

Definition at line 74 of file conf.py.

release

string conf.release = ''

Definition at line 59 of file conf.py.

source_suffix

string conf.source_suffix = '.rst'

Definition at line 42 of file conf.py.

templates_path

list conf.templates_path = ['_templates']

Definition at line 36 of file conf.py.

todo_include_todos

bool conf.todo_include_todos = False

Definition at line 77 of file conf.py.

version

string conf.version = ''

Definition at line 57 of file conf.py.