Edouard@810: # -*- coding: utf-8 -*-
Edouard@810: #
Edouard@810: # Beremiz documentation build configuration file, created by
Edouard@810: # sphinx-quickstart on Wed Sep  5 01:05:30 2012.
Edouard@810: #
Edouard@810: # This file is execfile()d with the current directory set to its containing dir.
Edouard@810: #
Edouard@810: # Note that not all possible configuration values are present in this
Edouard@810: # autogenerated file.
Edouard@810: #
Edouard@810: # All configuration values have a default; values that are commented out
Edouard@810: # serve to show the default.
Edouard@810: 
andrej@1732: import sys
andrej@1732: import os
Edouard@810: 
Edouard@810: # If extensions (or modules to document with autodoc) are in another directory,
Edouard@810: # add these directories to sys.path here. If the directory is relative to the
Edouard@810: # documentation root, use os.path.abspath to make it absolute, like shown here.
andrej@1782: # sys.path.insert(0, os.path.abspath('.'))
Edouard@810: 
Edouard@810: # -- General configuration -----------------------------------------------------
Edouard@810: 
Edouard@810: # If your documentation needs a minimal Sphinx version, state it here.
andrej@1782: # needs_sphinx = '1.0'
Edouard@810: 
Edouard@810: # Add any Sphinx extension module names here, as strings. They can be extensions
Edouard@810: # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
Edouard@810: extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
Edouard@810: 
Edouard@810: # Add any paths that contain templates here, relative to this directory.
Edouard@810: templates_path = ['_templates']
Edouard@810: 
Edouard@810: # The suffix of source filenames.
Edouard@810: source_suffix = '.rst'
Edouard@810: 
Edouard@810: # The encoding of source files.
andrej@1782: # source_encoding = 'utf-8-sig'
Edouard@810: 
Edouard@810: # The master toctree document.
Edouard@810: master_doc = 'index'
Edouard@810: 
Edouard@810: # General information about the project.
Edouard@810: project = u'Beremiz'
Edouard@811: copyright = u'is 21st century inquisition'
Edouard@810: 
Edouard@810: # The version info for the project you're documenting, acts as replacement for
Edouard@810: # |version| and |release|, also used in various other places throughout the
Edouard@810: # built documents.
Edouard@810: #
Edouard@810: # The short X.Y version.
Edouard@810: version = '1.1'
Edouard@810: # The full version, including alpha/beta/rc tags.
Edouard@810: release = '1.1rc1'
Edouard@810: 
Edouard@810: # The language for content autogenerated by Sphinx. Refer to documentation
Edouard@810: # for a list of supported languages.
andrej@1782: # language = None
Edouard@810: 
Edouard@811: gettext_compact = False
andrej@1746: locale_dirs = ["locale/"]
Edouard@811: 
Edouard@810: # There are two options for replacing |today|: either, you set today to some
Edouard@810: # non-false value, then it is used:
andrej@1782: # today = ''
Edouard@810: # Else, today_fmt is used as the format for a strftime call.
andrej@1782: # today_fmt = '%B %d, %Y'
Edouard@810: 
Edouard@810: # List of patterns, relative to source directory, that match files and
Edouard@810: # directories to ignore when looking for source files.
Edouard@810: exclude_patterns = ['_build']
Edouard@810: 
Edouard@810: # The reST default role (used for this markup: `text`) to use for all documents.
andrej@1782: # default_role = None
Edouard@810: 
Edouard@810: # If true, '()' will be appended to :func: etc. cross-reference text.
andrej@1782: # add_function_parentheses = True
Edouard@810: 
Edouard@810: # If true, the current module name will be prepended to all description
Edouard@810: # unit titles (such as .. function::).
andrej@1782: # add_module_names = True
Edouard@810: 
Edouard@810: # If true, sectionauthor and moduleauthor directives will be shown in the
Edouard@810: # output. They are ignored by default.
andrej@1782: # show_authors = False
Edouard@810: 
Edouard@810: # The name of the Pygments (syntax highlighting) style to use.
Edouard@810: pygments_style = 'sphinx'
Edouard@810: 
Edouard@810: # A list of ignored prefixes for module index sorting.
andrej@1782: # modindex_common_prefix = []
Edouard@810: 
Edouard@810: 
Edouard@810: # -- Options for HTML output ---------------------------------------------------
Edouard@810: 
Edouard@810: # The theme to use for HTML and HTML Help pages.  See the documentation for
Edouard@810: # a list of builtin themes.
Edouard@811: html_theme = 'sphinxdoc'
Edouard@810: 
Edouard@810: # Theme options are theme-specific and customize the look and feel of a theme
Edouard@810: # further.  For a list of options available for each theme, see the
Edouard@810: # documentation.
andrej@1782: # html_theme_options = {}
Edouard@810: 
Edouard@810: # Add any paths that contain custom themes here, relative to this directory.
andrej@1782: # html_theme_path = []
Edouard@810: 
Edouard@810: # The name for this set of Sphinx documents.  If None, it defaults to
Edouard@810: # "<project> v<release> documentation".
andrej@1782: # html_title = None
Edouard@810: 
Edouard@810: # A shorter title for the navigation bar.  Default is the same as html_title.
andrej@1782: # html_short_title = None
Edouard@810: 
Edouard@810: # The name of an image file (relative to this directory) to place at the top
Edouard@810: # of the sidebar.
andrej@1782: # html_logo = None
Edouard@810: 
Edouard@810: # The name of an image file (within the static path) to use as favicon of the
Edouard@810: # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
Edouard@810: # pixels large.
andrej@1782: # html_favicon = None
Edouard@810: 
Edouard@810: # Add any paths that contain custom static files (such as style sheets) here,
Edouard@810: # relative to this directory. They are copied after the builtin static files,
Edouard@810: # so a file named "default.css" will overwrite the builtin "default.css".
Edouard@810: html_static_path = ['_static']
Edouard@810: 
Edouard@810: # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
Edouard@810: # using the given strftime format.
andrej@1782: # html_last_updated_fmt = '%b %d, %Y'
Edouard@810: 
Edouard@810: # If true, SmartyPants will be used to convert quotes and dashes to
Edouard@810: # typographically correct entities.
andrej@1782: # html_use_smartypants = True
Edouard@810: 
Edouard@810: # Custom sidebar templates, maps document names to template names.
andrej@1782: # html_sidebars = {}
Edouard@810: 
Edouard@810: # Additional templates that should be rendered to pages, maps page names to
Edouard@810: # template names.
andrej@1782: # html_additional_pages = {}
Edouard@810: 
Edouard@810: # If false, no module index is generated.
andrej@1782: # html_domain_indices = True
Edouard@810: 
Edouard@810: # If false, no index is generated.
andrej@1782: # html_use_index = True
Edouard@810: 
Edouard@810: # If true, the index is split into individual pages for each letter.
andrej@1782: # html_split_index = False
Edouard@810: 
Edouard@810: # If true, links to the reST sources are added to the pages.
andrej@1782: # html_show_sourcelink = True
Edouard@810: 
Edouard@810: # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
andrej@1782: # html_show_sphinx = True
Edouard@810: 
Edouard@810: # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
andrej@1782: # html_show_copyright = True
Edouard@810: 
Edouard@810: # If true, an OpenSearch description file will be output, and all pages will
Edouard@810: # contain a <link> tag referring to it.  The value of this option must be the
Edouard@810: # base URL from which the finished HTML is served.
andrej@1782: # html_use_opensearch = ''
Edouard@810: 
Edouard@810: # This is the file name suffix for HTML files (e.g. ".xhtml").
andrej@1782: # html_file_suffix = None
Edouard@810: 
Edouard@810: # Output file base name for HTML help builder.
Edouard@810: htmlhelp_basename = 'Beremizdoc'
Edouard@810: 
Edouard@810: 
Edouard@810: # -- Options for LaTeX output --------------------------------------------------
Edouard@810: 
Edouard@810: latex_elements = {
andrej@1776:     # The paper size ('letterpaper' or 'a4paper').
andrej@1782:     # 'papersize': 'letterpaper',
andrej@1776: 
andrej@1776:     # The font size ('10pt', '11pt' or '12pt').
andrej@1782:     # 'pointsize': '10pt',
andrej@1776: 
andrej@1776:     # Additional stuff for the LaTeX preamble.
andrej@1782:     # 'preamble': '',
Edouard@810: }
Edouard@810: 
Edouard@810: # Grouping the document tree into LaTeX files. List of tuples
Edouard@810: # (source start file, target name, title, author, documentclass [howto/manual]).
Edouard@810: latex_documents = [
Edouard@810:   ('index', 'Beremiz.tex', u'Beremiz Documentation',
Edouard@811:    u'Beremiz Documentation Authors', 'manual'),
Edouard@810: ]
Edouard@810: 
Edouard@810: # The name of an image file (relative to this directory) to place at the top of
Edouard@810: # the title page.
andrej@1782: # latex_logo = None
Edouard@810: 
Edouard@810: # For "manual" documents, if this is true, then toplevel headings are parts,
Edouard@810: # not chapters.
andrej@1782: # latex_use_parts = False
Edouard@810: 
Edouard@810: # If true, show page references after internal links.
andrej@1782: # latex_show_pagerefs = False
Edouard@810: 
Edouard@810: # If true, show URL addresses after external links.
andrej@1782: # latex_show_urls = False
Edouard@810: 
Edouard@810: # Documents to append as an appendix to all manuals.
andrej@1782: # latex_appendices = []
Edouard@810: 
Edouard@810: # If false, no module index is generated.
andrej@1782: # latex_domain_indices = True
Edouard@810: 
Edouard@810: 
Edouard@810: # -- Options for manual page output --------------------------------------------
Edouard@810: 
Edouard@810: # One entry per manual page. List of tuples
Edouard@810: # (source start file, name, description, authors, manual section).
Edouard@810: man_pages = [
Edouard@810:     ('index', 'beremiz', u'Beremiz Documentation',
Edouard@811:      [u'Beremiz Documentation Authors'], 1)
Edouard@810: ]
Edouard@810: 
Edouard@810: # If true, show URL addresses after external links.
andrej@1782: # man_show_urls = False
Edouard@810: 
Edouard@810: 
Edouard@810: # -- Options for Texinfo output ------------------------------------------------
Edouard@810: 
Edouard@810: # Grouping the document tree into Texinfo files. List of tuples
Edouard@810: # (source start file, target name, title, author,
Edouard@810: #  dir menu entry, description, category)
Edouard@810: texinfo_documents = [
Edouard@810:   ('index', 'Beremiz', u'Beremiz Documentation',
Edouard@811:    u'Beremiz Documentation Authors', 'Beremiz', 'One line description of project.',
Edouard@810:    'Miscellaneous'),
Edouard@810: ]
Edouard@810: 
Edouard@810: # Documents to append as an appendix to all manuals.
andrej@1782: # texinfo_appendices = []
Edouard@810: 
Edouard@810: # If false, no module index is generated.
andrej@1782: # texinfo_domain_indices = True
Edouard@810: 
Edouard@810: # How to display URL addresses: 'footnote', 'no', or 'inline'.
andrej@1782: # texinfo_show_urls = 'footnote'