1

# -*- coding: utf-8 -*-

     2

#

     3

# Beremiz documentation build configuration file, created by

     4

# sphinx-quickstart on Wed Sep  5 01:05:30 2012.

     5

#

     6

# This file is execfile()d with the current directory set to its containing dir.

     7

#

     8

# Note that not all possible configuration values are present in this

     9

# autogenerated file.

    10

#

    11

# All configuration values have a default; values that are commented out

    12

# serve to show the default.

    13

    14

# If extensions (or modules to document with autodoc) are in another directory,

    15

# add these directories to sys.path here. If the directory is relative to the

    16

# documentation root, use os.path.abspath to make it absolute, like shown here.

    17

import sys

    18

import os

    19

sys.path.insert(0, os.path.abspath('..'))

    20

    21

# -- General configuration -----------------------------------------------------

    22

    23

# If your documentation needs a minimal Sphinx version, state it here.

    24

# needs_sphinx = '1.0'

    25

    26

# Add any Sphinx extension module names here, as strings. They can be extensions

    27

# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.

    28

extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']

    29

    30

# Add any paths that contain templates here, relative to this directory.

    31

templates_path = ['_templates']

    32

    33

# The suffix of source filenames.

    34

source_suffix = '.rst'

    35

    36

# The encoding of source files.

    37

# source_encoding = 'utf-8-sig'

    38

    39

# The master toctree document.

    40

master_doc = 'index'

    41

    42

# General information about the project.

    43

project = u'Beremiz'

    44

copyright = u'is 21st century inquisition'

    45

    46

# The version info for the project you're documenting, acts as replacement for

    47

# |version| and |release|, also used in various other places throughout the

    48

# built documents.

    49

#

    50

# The short X.Y version.

    51

import version as bversion

    52

    53

version = bversion.app_version

    54

# The full version, including alpha/beta/rc tags.

    55

release = bversion.app_version

    56

    57

# The language for content autogenerated by Sphinx. Refer to documentation

    58

# for a list of supported languages.

    59

# language = None

    60

    61

gettext_compact = False

    62

locale_dirs = ["locale/"]

    63

    64

# There are two options for replacing |today|: either, you set today to some

    65

# non-false value, then it is used:

    66

# today = ''

    67

# Else, today_fmt is used as the format for a strftime call.

    68

# today_fmt = '%B %d, %Y'

    69

    70

# List of patterns, relative to source directory, that match files and

    71

# directories to ignore when looking for source files.

    72

exclude_patterns = ['_build']

    73

    74

# The reST default role (used for this markup: `text`) to use for all documents.

    75

# default_role = None

    76

    77

# If true, '()' will be appended to :func: etc. cross-reference text.

    78

# add_function_parentheses = True

    79

    80

# If true, the current module name will be prepended to all description

    81

# unit titles (such as .. function::).

    82

# add_module_names = True

    83

    84

# If true, sectionauthor and moduleauthor directives will be shown in the

    85

# output. They are ignored by default.

    86

# show_authors = False

    87

    88

# The name of the Pygments (syntax highlighting) style to use.

    89

pygments_style = 'sphinx'

    90

    91

# A list of ignored prefixes for module index sorting.

    92

# modindex_common_prefix = []

    93

    94

    95

# -- Options for HTML output ---------------------------------------------------

    96

    97

# The theme to use for HTML and HTML Help pages.  See the documentation for

    98

# a list of builtin themes.

    99

html_theme = 'sphinxdoc'

   100

   101

# Theme options are theme-specific and customize the look and feel of a theme

   102

# further.  For a list of options available for each theme, see the

   103

# documentation.

   104

# html_theme_options = {}

   105

   106

# Add any paths that contain custom themes here, relative to this directory.

   107

# html_theme_path = []

   108

   109

# The name for this set of Sphinx documents.  If None, it defaults to

   110

# "<project> v<release> documentation".

   111

# html_title = None

   112

   113

# A shorter title for the navigation bar.  Default is the same as html_title.

   114

# html_short_title = None

   115

   116

# The name of an image file (relative to this directory) to place at the top

   117

# of the sidebar.

   118

# html_logo = None

   119

   120

# The name of an image file (within the static path) to use as favicon of the

   121

# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32

   122

# pixels large.

   123

# html_favicon = None

   124

   125

# Add any paths that contain custom static files (such as style sheets) here,

   126

# relative to this directory. They are copied after the builtin static files,

   127

# so a file named "default.css" will overwrite the builtin "default.css".

   128

html_static_path = ['_static']

   129

   130

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,

   131

# using the given strftime format.

   132

# html_last_updated_fmt = '%b %d, %Y'

   133

   134

# If true, SmartyPants will be used to convert quotes and dashes to

   135

# typographically correct entities.

   136

# html_use_smartypants = True

   137

   138

# Custom sidebar templates, maps document names to template names.

   139

# html_sidebars = {}

   140

   141

# Additional templates that should be rendered to pages, maps page names to

   142

# template names.

   143

# html_additional_pages = {}

   144

   145

# If false, no module index is generated.

   146

# html_domain_indices = True

   147

   148

# If false, no index is generated.

   149

# html_use_index = True

   150

   151

# If true, the index is split into individual pages for each letter.

   152

# html_split_index = False

   153

   154

# If true, links to the reST sources are added to the pages.

   155

# html_show_sourcelink = True

   156

   157

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.

   158

# html_show_sphinx = True

   159

   160

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.

   161

# html_show_copyright = True

   162

   163

# If true, an OpenSearch description file will be output, and all pages will

   164

# contain a <link> tag referring to it.  The value of this option must be the

   165

# base URL from which the finished HTML is served.

   166

# html_use_opensearch = ''

   167

   168

# This is the file name suffix for HTML files (e.g. ".xhtml").

   169

# html_file_suffix = None

   170

   171

# Output file base name for HTML help builder.

   172

htmlhelp_basename = 'Beremizdoc'

   173

   174

   175

# -- Options for LaTeX output --------------------------------------------------

   176

   177

latex_elements = {

   178

    # The paper size ('letterpaper' or 'a4paper').

   179

    # 'papersize': 'letterpaper',

   180

   181

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

   182

    # 'pointsize': '10pt',

   183

   184

    # Additional stuff for the LaTeX preamble.

   185

    # 'preamble': '',

   186

}

   187

   188

# Grouping the document tree into LaTeX files. List of tuples

   189

# (source start file, target name, title, author, documentclass [howto/manual]).

   190

latex_documents = [

   191

    ('index', 'Beremiz.tex', u'Beremiz Documentation',

   192

     u'Beremiz Documentation Authors', 'manual'),

   193

]

   194

   195

# The name of an image file (relative to this directory) to place at the top of

   196

# the title page.

   197

# latex_logo = None

   198

   199

# For "manual" documents, if this is true, then toplevel headings are parts,

   200

# not chapters.

   201

# latex_use_parts = False

   202

   203

# If true, show page references after internal links.

   204

# latex_show_pagerefs = False

   205

   206

# If true, show URL addresses after external links.

   207

# latex_show_urls = False

   208

   209

# Documents to append as an appendix to all manuals.

   210

# latex_appendices = []

   211

   212

# If false, no module index is generated.

   213

# latex_domain_indices = True

   214

   215

   216

# -- Options for manual page output --------------------------------------------

   217

   218

# One entry per manual page. List of tuples

   219

# (source start file, name, description, authors, manual section).

   220

man_pages = [

   221

    ('index', 'beremiz', u'Beremiz Documentation',

   222

     [u'Beremiz Documentation Authors'], 1)

   223

]

   224

   225

# If true, show URL addresses after external links.

   226

# man_show_urls = False

   227

   228

   229

# -- Options for Texinfo output ------------------------------------------------

   230

   231

# Grouping the document tree into Texinfo files. List of tuples

   232

# (source start file, target name, title, author,

   233

#  dir menu entry, description, category)

   234

texinfo_documents = [

   235

    ('index', 'Beremiz', u'Beremiz Documentation',

   236

     u'Beremiz Documentation Authors', 'Beremiz', 'One line description of project.',

   237

     'Miscellaneous'),

   238

]

   239

   240

# Documents to append as an appendix to all manuals.

   241

# texinfo_appendices = []

   242

   243

# If false, no module index is generated.

   244

# texinfo_domain_indices = True

   245

   246

# How to display URL addresses: 'footnote', 'no', or 'inline'.

   247

# texinfo_show_urls = 'footnote'