conf Namespace Reference

Functions
	linkcode_resolve (domain, info)

Variables
list	extensions
list	templates_path = ['_templates']
str	source_suffix = '.rst'
str	master_doc = 'index'
str	project = 'Lattice Microbes'
str	copyright = '{}, Luthey-Schulten Lab'.format(datetime.datetime.now().year)
tuple	author
str	version = '2.5'
str	release = '2.5_dev'
str	language = 'en'
list	exclude_patterns = []
str	pygments_style = 'sphinx'
bool	todo_include_todos = True
str	html_theme = "pydata_sphinx_theme"
dict	html_theme_options
list	html_static_path = ['_static']
dict	intersphinx_mapping
dict	autodoc_default_options
bool	autosummary_generate = True
bool	autosummary_imported_members = True
str	autodoc_member_order = 'groupwise'
str	autoclass_content = 'both'
bool	html_show_sourcelink = True
dict	breathe_projects
str	breathe_default_project = "LatticeMicrobes"
tuple	breathe_default_members = ('members', 'undoc-members', 'show-source')
bool	breathe_show_define_initializer = True
bool	breathe_show_enumvalue_initializer = True
bool	breathe_show_include = True
bool	breathe_show_define = True
bool	breathe_show_enum = True
list	breathe_implementation_filename_extensions = ['.c', '.cc', '.cpp', '.cu']
bool	breathe_use_project_refids = True
str	breathe_default_highlight_language = "cpp"
bool	breathe_show_enumvalue = True
dict	breathe_domain_by_extension
bool	breathe_order_parameters_first = True
str	github_repo = "https://github.com/Luthey-Schulten-Lab/Lattice-Microbes"
str	github_branch = "main"

Function Documentation

linkcode_resolve()

conf.linkcode_resolve	(		domain,
			info )

Generate links to GitHub source code for C++ classes and functions

Variable Documentation

author

tuple conf.author

Initial value:

=  (
    'Tianyu Wu, '
    'Henry(Hongyi) Li, '
    'Zane Thronburg, '
    'Tyler M. Earnest, '
    'Michael J. Hallock, '
    'Andrew Magis, '
    'Joseph R. Peterson, '
    'Elijah Roberts')

autoclass_content

str conf.autoclass_content = 'both'

autodoc_default_options

dict conf.autodoc_default_options

Initial value:

=  {
    'members': True,
    'show-inheritance': True, 
    'inherited-members': True,
    'undoc-members': True,
}

autodoc_member_order

str conf.autodoc_member_order = 'groupwise'

autosummary_generate

bool conf.autosummary_generate = True

autosummary_imported_members

bool conf.autosummary_imported_members = True

breathe_default_highlight_language

str conf.breathe_default_highlight_language = "cpp"

breathe_default_members

tuple conf.breathe_default_members = ('members', 'undoc-members', 'show-source')

breathe_default_project

str conf.breathe_default_project = "LatticeMicrobes"

breathe_domain_by_extension

dict conf.breathe_domain_by_extension

Initial value:

=  {
    "h" : "cpp",
    "hpp" : "cpp", 
    "cpp" : "cpp",
    "cu" : "cuda"
}

breathe_implementation_filename_extensions

list conf.breathe_implementation_filename_extensions = ['.c', '.cc', '.cpp', '.cu']

breathe_order_parameters_first

bool conf.breathe_order_parameters_first = True

breathe_projects

dict conf.breathe_projects

Initial value:

=  {
    "LatticeMicrobes": "./xml"
}

breathe_show_define

bool conf.breathe_show_define = True

breathe_show_define_initializer

bool conf.breathe_show_define_initializer = True

breathe_show_enum

bool conf.breathe_show_enum = True

breathe_show_enumvalue

bool conf.breathe_show_enumvalue = True

breathe_show_enumvalue_initializer

bool conf.breathe_show_enumvalue_initializer = True

breathe_show_include

bool conf.breathe_show_include = True

breathe_use_project_refids

bool conf.breathe_use_project_refids = True

copyright

str conf.copyright = '{}, Luthey-Schulten Lab'.format(datetime.datetime.now().year)

exclude_patterns

list conf.exclude_patterns = []

extensions

list conf.extensions

Initial value:

=  ['sphinx.ext.autosummary',
                  'sphinx.ext.autodoc',
                  'sphinx.ext.coverage',
                  'sphinx.ext.mathjax',
                  'sphinx.ext.napoleon',
                  'sphinx.ext.todo',
                  'sphinx.ext.viewcode',
                  'sphinx.ext.linkcode',
                  'breathe']

github_branch

str conf.github_branch = "main"

github_repo

str conf.github_repo = "https://github.com/Luthey-Schulten-Lab/Lattice-Microbes"

html_show_sourcelink

bool conf.html_show_sourcelink = True

html_static_path

list conf.html_static_path = ['_static']

html_theme

str conf.html_theme = "pydata_sphinx_theme"

html_theme_options

dict conf.html_theme_options

Initial value:

=  {
    "navigation_with_keys": True,
    "show_nav_level": 3,
    "show_toc_level": 3,
    "collapse_navigation": False,
    "navbar_align": "left",
    "use_edit_page_button": False,
    "navigation_depth": 4,
    "show_prev_next": True,
    "navbar_center": ["navbar-nav"],
    "navbar_end": ["navbar-icon-links"],
    "icon_links": [],
    "logo": {
        "text": "Lattice Microbes",
    },
    # Priority navigation items (prevent from going to "More")
    "primary_sidebar_end": ["navbar-nav"],
}

intersphinx_mapping

dict conf.intersphinx_mapping

Initial value:

=  {'python': ('https://docs.python.org/release/3.7.3/', None),
                       'numpy':  ('http://docs.scipy.org/doc/numpy/', None)}

language

str conf.language = 'en'

master_doc

str conf.master_doc = 'index'

project

str conf.project = 'Lattice Microbes'

pygments_style

str conf.pygments_style = 'sphinx'

release

str conf.release = '2.5_dev'

source_suffix

str conf.source_suffix = '.rst'

templates_path

list conf.templates_path = ['_templates']

todo_include_todos

bool conf.todo_include_todos = True

version

str conf.version = '2.5'