conf Namespace Reference

Functions
def	setup (app)

Variables
string	project = 'Kagome'
string	copyright = '2020, Soramitsu Co., Ltd.'
string	author = 'Soramitsu Co., Ltd.'
string	version = ''
string	release = '0.0.1'
list	extensions
list	templates_path = ['_templates']
dictionary	source_suffix
string	master_doc = 'index'
string	github_doc_root = 'https://github.com/rtfd/recommonmark/tree/master/doc/'
	language = None
list	exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
string	pygments_style = 'sphinx'
list	html_static_path = ['_static']
string	html_theme = 'sphinx_rtd_theme'

Function Documentation

def conf.setup

(

app

)

Definition at line 54 of file conf.py.

Variable Documentation

string conf.author = 'Soramitsu Co., Ltd.'

Definition at line 13 of file conf.py.

string conf.copyright = '2020, Soramitsu Co., Ltd.'

Definition at line 12 of file conf.py.

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

Definition at line 71 of file conf.py.

list conf.extensions

Initial value:

= [
    'sphinx.ext.todo',
    'sphinx.ext.githubpages',
    'sphinx_markdown_tables',
    'recommonmark'
]

Definition at line 29 of file conf.py.

string conf.github_doc_root = 'https://github.com/rtfd/recommonmark/tree/master/doc/'

Definition at line 53 of file conf.py.

list conf.html_static_path = ['_static']

Definition at line 92 of file conf.py.

string conf.html_theme = 'sphinx_rtd_theme'

Definition at line 103 of file conf.py.

conf.language = None

Definition at line 66 of file conf.py.

string conf.master_doc = 'index'

Definition at line 50 of file conf.py.

string conf.project = 'Kagome'

Definition at line 11 of file conf.py.

string conf.pygments_style = 'sphinx'

Definition at line 74 of file conf.py.

string conf.release = '0.0.1'

Definition at line 18 of file conf.py.

dictionary conf.source_suffix

Initial value:

= {
    '.rst': 'restructuredtext',
    '.txt': 'markdown',
    '.md': 'markdown',
}

Definition at line 43 of file conf.py.

list conf.templates_path = ['_templates']

Definition at line 37 of file conf.py.

string conf.version = ''

Definition at line 16 of file conf.py.