dcdfort
Modern Fortran library for analyzing DCD trajectories
Variables
conf Namespace Reference

Variables

list extensions
 
dictionary breathe_projects = { "dcdfort":"./doxyxml" }
 
string breathe_default_project = "dcdfort"
 
list templates_path = ['_templates']
 
string source_suffix = '.rst'
 
string master_doc = 'index'
 
string project = 'dcdfort'
 
string copyright = '2017, James W. Barnett'
 
string author = 'James W. Barnett'
 
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 = 'sphinx_rtd_theme'
 
list html_static_path = ['_static']
 
dictionary html_sidebars
 
string htmlhelp_basename = 'dcdfortdoc'
 
dictionary latex_elements
 
list latex_documents
 
list man_pages
 
list texinfo_documents
 

Variable Documentation

◆ author

string conf.author = 'James W. Barnett'

◆ breathe_default_project

string conf.breathe_default_project = "dcdfort"

◆ breathe_projects

dictionary conf.breathe_projects = { "dcdfort":"./doxyxml" }

◆ copyright

string conf.copyright = '2017, James W. Barnett'

◆ exclude_patterns

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

◆ extensions

list conf.extensions
Initial value:
1 = ['sphinx.ext.autodoc',
2  'sphinx.ext.ifconfig',
3  'breathe'
4  ]

◆ html_sidebars

dictionary conf.html_sidebars
Initial value:
1 = {
2  '**': [
3  'about.html',
4  'navigation.html',
5  'relations.html', # needs 'show_related': True theme option to display
6  'searchbox.html',
7  'donate.html',
8  ]
9 }

◆ html_static_path

list conf.html_static_path = ['_static']

◆ html_theme

string conf.html_theme = 'sphinx_rtd_theme'

◆ htmlhelp_basename

string conf.htmlhelp_basename = 'dcdfortdoc'

◆ language

conf.language = None

◆ latex_documents

list conf.latex_documents
Initial value:
1 = [
2  (master_doc, 'dcdfort.tex', 'dcdfort Documentation',
3  'James W. Barnett', 'manual'),
4 ]

◆ latex_elements

dictionary conf.latex_elements
Initial value:
1 = {
2  # The paper size ('letterpaper' or 'a4paper').
3  #
4  # 'papersize': 'letterpaper',
5 
6  # The font size ('10pt', '11pt' or '12pt').
7  #
8  # 'pointsize': '10pt',
9 
10  # Additional stuff for the LaTeX preamble.
11  #
12  # 'preamble': '',
13 
14  # Latex figure (float) alignment
15  #
16  # 'figure_align': 'htbp',
17 }

◆ man_pages

list conf.man_pages
Initial value:
1 = [
2  (master_doc, 'dcdfort', 'dcdfort Documentation',
3  [author], 1)
4 ]

◆ master_doc

string conf.master_doc = 'index'

◆ project

string conf.project = 'dcdfort'

◆ pygments_style

string conf.pygments_style = 'sphinx'

◆ release

string conf.release = ''

◆ source_suffix

string conf.source_suffix = '.rst'

◆ templates_path

list conf.templates_path = ['_templates']

◆ texinfo_documents

list conf.texinfo_documents
Initial value:
1 = [
2  (master_doc, 'dcdfort', 'dcdfort Documentation',
3  author, 'dcdfort', 'One line description of project.',
4  'Miscellaneous'),
5 ]

◆ todo_include_todos

bool conf.todo_include_todos = False

◆ version

string conf.version = ''