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

import sys

    15

import os

    16

    17

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

    18

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

    19

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

    20

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

    21

    22

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

    23

    24

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

    25

# needs_sphinx = '1.0'

    26

    27

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

    28

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

    29

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

    30

    31

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

    32

templates_path = ['_templates']

    33

    34

# The suffix of source filenames.

    35

source_suffix = '.rst'

    36

    37

# The encoding of source files.

    38

# source_encoding = 'utf-8-sig'

    39

    40

# The master toctree document.

    41

master_doc = 'index'

    42

    43

# General information about the project.

    44

project = u'Beremiz'

    45

copyright = u'is 21st century inquisition'

    46

    47

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

    48

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

    49

# built documents.

    50

#

    51

# The short X.Y version.

    52

version = '1.1'

    53

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

    54

release = '1.1rc1'

    55

    56

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

    57

# for a list of supported languages.

    58

# language = None

    59

    60

gettext_compact = False

    61

locale_dirs = ["locale/"]

    62

    63

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

    64

# non-false value, then it is used:

    65

# today = ''

    66

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

    67

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

    68

    69

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

    70

# directories to ignore when looking for source files.

    71

exclude_patterns = ['_build']

    72

    73

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

    74

# default_role = None

    75

    76

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

    77

# add_function_parentheses = True

    78

    79

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

    80

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

    81

# add_module_names = True

    82

    83

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

    84

# output. They are ignored by default.

    85

# show_authors = False

    86

    87

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

    88

pygments_style = 'sphinx'

    89

    90

# A list of ignored prefixes for module index sorting.

    91

# modindex_common_prefix = []

    92

    93

    94

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

    95

    96

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

    97

# a list of builtin themes.

    98

html_theme = 'sphinxdoc'

    99

   100

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

   101

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

   102

# documentation.

   103

# html_theme_options = {}

   104

   105

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

   106

# html_theme_path = []

   107

   108

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

   109

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

   110

# html_title = None

   111

   112

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

   113

# html_short_title = None

   114

   115

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

   116

# of the sidebar.

   117

# html_logo = None

   118

   119

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

   120

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

   121

# pixels large.

   122

# html_favicon = None

   123

   124

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

   125

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

   126

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

   127

html_static_path = ['_static']

   128

   129

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

   130

# using the given strftime format.

   131

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

   132

   133

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

   134

# typographically correct entities.

   135

# html_use_smartypants = True

   136

   137

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

   138

# html_sidebars = {}

   139

   140

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

   141

# template names.

   142

# html_additional_pages = {}

   143

   144

# If false, no module index is generated.

   145

# html_domain_indices = True

   146

   147

# If false, no index is generated.

   148

# html_use_index = True

   149

   150

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

   151

# html_split_index = False

   152

   153

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

   154

# html_show_sourcelink = True

   155

   156

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

   157

# html_show_sphinx = True

   158

   159

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

   160

# html_show_copyright = True

   161

   162

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

   163

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

   164

# base URL from which the finished HTML is served.

   165

# html_use_opensearch = ''

   166

   167

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

   168

# html_file_suffix = None

   169

   170

# Output file base name for HTML help builder.

   171

htmlhelp_basename = 'Beremizdoc'

   172

   173

   174

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

   175

   176

latex_elements = {

   177

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

   178

    # 'papersize': 'letterpaper',

   179

   180

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

   181

    # 'pointsize': '10pt',

   182

   183

    # Additional stuff for the LaTeX preamble.

   184

    # 'preamble': '',

   185

}

   186

   187

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

   188

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

   189

latex_documents = [

   190

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

   191

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

   192

]

   193

   194

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

   195

# the title page.

   196

# latex_logo = None

   197

   198

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

   199

# not chapters.

   200

# latex_use_parts = False

   201

   202

# If true, show page references after internal links.

   203

# latex_show_pagerefs = False

   204

   205

# If true, show URL addresses after external links.

   206

# latex_show_urls = False

   207

   208

# Documents to append as an appendix to all manuals.

   209

# latex_appendices = []

   210

   211

# If false, no module index is generated.

   212

# latex_domain_indices = True

   213

   214

   215

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

   216

   217

# One entry per manual page. List of tuples

   218

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

   219

man_pages = [

   220

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

   221

     [u'Beremiz Documentation Authors'], 1)

   222

]

   223

   224

# If true, show URL addresses after external links.

   225

# man_show_urls = False

   226

   227

   228

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

   229

   230

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

   231

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

   232

#  dir menu entry, description, category)

   233

texinfo_documents = [

   234

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

   235

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

   236

   'Miscellaneous'),

   237

]

   238

   239

# Documents to append as an appendix to all manuals.

   240

# texinfo_appendices = []

   241

   242

# If false, no module index is generated.

   243

# texinfo_domain_indices = True

   244

   245

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

   246

# texinfo_show_urls = 'footnote'