namespace conf

conf

Attributes

Name
listextensions
listtemplates_path
stringsource_suffix
stringmaster_doc
stringproject
stringcopyright
version
release
listexclude_patterns
stringpygments_style
stringhtml_theme
listhtml_static_path
stringhtmlhelp_basename
dictionarylatex_elements
listlatex_documents
listman_pages
listtexinfo_documents

Attributes Documentation

variable extensions

list extensions =  [
    'sphinx.ext.autodoc',
    'sphinx.ext.todo',
    'sphinx.ext.coverage',
    'sphinx.ext.mathjax',
    'sphinx.ext.viewcode',
];

variable templates_path

list templates_path =  ['_templates'];

variable source_suffix

string source_suffix =  '.rst';

variable master_doc

string master_doc =  'index';

variable project

string project =  u'YODA';
string copyright =  u'2010-2017, YODA Collaboration';

variable version

version =  yoda.__version__;

variable release

release =  yoda.__version__;

variable exclude_patterns

list exclude_patterns =  ['_build'];

variable pygments_style

string pygments_style =  'sphinx';

variable html_theme

string html_theme =  'default';

variable html_static_path

list html_static_path =  ['_static'];

variable htmlhelp_basename

string htmlhelp_basename =  'YODAdoc';

variable latex_elements

dictionary latex_elements =  {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#'preamble': '',
};

variable latex_documents

list latex_documents =  [
  ('index', 'YODA.tex', u'YODA Documentation',
   u'YODA Collaboration', 'manual'),
];

variable man_pages

list man_pages =  [
    ('index', 'yoda', u'YODA Documentation',
     [u'YODA Collaboration'], 1)
];

variable texinfo_documents

list texinfo_documents =  [
  ('index', 'YODA', u'YODA Documentation',
   u'YODA Collaboration', 'YODA', 'One line description of project.',
   'Miscellaneous'),
];

Updated on 2022-08-08 at 20:05:55 +0100