conf Namespace Reference

Variables
string	author = u'Jose Luis Blanco Claraco'
string	copyright = datetime.date.today().strftime("%Y") + u', ' + author
list	exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
list	extensions
list	html_static_path = ['_static']
string	html_theme = "sphinx_rtd_theme"
dictionary	html_theme_options
list	html_theme_path = ["_themes", ]
string	master_doc = 'index'
string	project = 'mvsim'
string	read_the_docs_build = 'True'
string	rst_epilog
	shell
list	templates_path = ['_templates']

Variable Documentation

author

string conf.author = u'Jose Luis Blanco Claraco'

Definition at line 31 of file conf.py.

copyright

string conf.copyright = datetime.date.today().strftime("%Y") + u', ' + author

Definition at line 32 of file conf.py.

exclude_patterns

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

Definition at line 72 of file conf.py.

extensions

list conf.extensions

Initial value:

=  [
    'sphinx_rtd_theme',
    'sphinx.ext.mathjax',
    'sphinx_design'
]

Definition at line 60 of file conf.py.

html_static_path

list conf.html_static_path = ['_static']

Definition at line 86 of file conf.py.

html_theme

string conf.html_theme = "sphinx_rtd_theme"

Definition at line 50 of file conf.py.

html_theme_options

dictionary conf.html_theme_options

Initial value:

=  {
    # 'canonical_url': '',
    'analytics_id': 'UA-21128561-9',  # Provided by Google in your dashboard
    'logo_only': False,
    'display_version': True,
    'prev_next_buttons_location': 'bottom',
    'style_external_links': False,
    'style_nav_header_background': 'white',
    # Toc options
    'collapse_navigation': True,
    'sticky_navigation': True,
    'navigation_depth': 4,
    'includehidden': True,
    'titles_only': False
}

Definition at line 34 of file conf.py.

html_theme_path

list conf.html_theme_path = ["_themes", ]

Definition at line 81 of file conf.py.

master_doc

string conf.master_doc = 'index'

Definition at line 55 of file conf.py.

project

string conf.project = 'mvsim'

Definition at line 30 of file conf.py.

read_the_docs_build

string conf.read_the_docs_build = 'True'

Definition at line 22 of file conf.py.

rst_epilog

string conf.rst_epilog

Initial value:

=  """
.. role:: raw-html(raw)
    :format: html
"""

Definition at line 89 of file conf.py.

shell

conf.shell

Definition at line 25 of file conf.py.

templates_path

list conf.templates_path = ['_templates']

Definition at line 67 of file conf.py.