doc/conf.py
author Andrey Skvortsov <andrej.skvortzov@gmail.com>
Wed, 05 Jul 2017 13:02:30 +0300
changeset 1715 f50486ecdc21
parent 811 66a8812457d6
child 1732 94ffe74e6895
permissions -rw-r--r--
mki18n.py: generate messages.po (contains English strings in msgstr)

This po file is necessary because Transifex translation platform
automatically can only import PO files. Usually messages.pot is
enough.
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
     1
# -*- coding: utf-8 -*-
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
     2
#
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
     3
# Beremiz documentation build configuration file, created by
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
     4
# sphinx-quickstart on Wed Sep  5 01:05:30 2012.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
     5
#
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
     6
# This file is execfile()d with the current directory set to its containing dir.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
     7
#
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
     8
# Note that not all possible configuration values are present in this
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
     9
# autogenerated file.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    10
#
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    11
# All configuration values have a default; values that are commented out
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    12
# serve to show the default.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    13
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    14
import sys, os
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    15
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    16
# If extensions (or modules to document with autodoc) are in another directory,
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    17
# add these directories to sys.path here. If the directory is relative to the
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    18
# documentation root, use os.path.abspath to make it absolute, like shown here.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    19
#sys.path.insert(0, os.path.abspath('.'))
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    20
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    21
# -- General configuration -----------------------------------------------------
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    22
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    23
# If your documentation needs a minimal Sphinx version, state it here.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    24
#needs_sphinx = '1.0'
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    25
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    26
# Add any Sphinx extension module names here, as strings. They can be extensions
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    27
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    28
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    29
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    30
# Add any paths that contain templates here, relative to this directory.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    31
templates_path = ['_templates']
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    32
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    33
# The suffix of source filenames.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    34
source_suffix = '.rst'
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    35
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    36
# The encoding of source files.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    37
#source_encoding = 'utf-8-sig'
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    38
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    39
# The master toctree document.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    40
master_doc = 'index'
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    41
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    42
# General information about the project.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    43
project = u'Beremiz'
811
66a8812457d6 Added subdirectories in documentation, with more deoctree items to test. Enabled i18n in sphinx doc, tested with a small french translation
Edouard Tisserant
parents: 810
diff changeset
    44
copyright = u'is 21st century inquisition'
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    45
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    46
# The version info for the project you're documenting, acts as replacement for
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    47
# |version| and |release|, also used in various other places throughout the
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    48
# built documents.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    49
#
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    50
# The short X.Y version.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    51
version = '1.1'
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    52
# The full version, including alpha/beta/rc tags.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    53
release = '1.1rc1'
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    54
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    55
# The language for content autogenerated by Sphinx. Refer to documentation
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    56
# for a list of supported languages.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    57
#language = None
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    58
811
66a8812457d6 Added subdirectories in documentation, with more deoctree items to test. Enabled i18n in sphinx doc, tested with a small french translation
Edouard Tisserant
parents: 810
diff changeset
    59
gettext_compact = False
66a8812457d6 Added subdirectories in documentation, with more deoctree items to test. Enabled i18n in sphinx doc, tested with a small french translation
Edouard Tisserant
parents: 810
diff changeset
    60
locale_dirs = [ "locale/" ]
66a8812457d6 Added subdirectories in documentation, with more deoctree items to test. Enabled i18n in sphinx doc, tested with a small french translation
Edouard Tisserant
parents: 810
diff changeset
    61
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    62
# There are two options for replacing |today|: either, you set today to some
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    63
# non-false value, then it is used:
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    64
#today = ''
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    65
# Else, today_fmt is used as the format for a strftime call.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    66
#today_fmt = '%B %d, %Y'
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    67
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    68
# List of patterns, relative to source directory, that match files and
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    69
# directories to ignore when looking for source files.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    70
exclude_patterns = ['_build']
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    71
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    72
# The reST default role (used for this markup: `text`) to use for all documents.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    73
#default_role = None
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    74
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    75
# If true, '()' will be appended to :func: etc. cross-reference text.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    76
#add_function_parentheses = True
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    77
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    78
# If true, the current module name will be prepended to all description
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    79
# unit titles (such as .. function::).
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    80
#add_module_names = True
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    81
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    82
# If true, sectionauthor and moduleauthor directives will be shown in the
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    83
# output. They are ignored by default.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    84
#show_authors = False
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    85
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    86
# The name of the Pygments (syntax highlighting) style to use.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    87
pygments_style = 'sphinx'
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    88
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    89
# A list of ignored prefixes for module index sorting.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    90
#modindex_common_prefix = []
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    91
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    92
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    93
# -- Options for HTML output ---------------------------------------------------
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    94
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    95
# The theme to use for HTML and HTML Help pages.  See the documentation for
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    96
# a list of builtin themes.
811
66a8812457d6 Added subdirectories in documentation, with more deoctree items to test. Enabled i18n in sphinx doc, tested with a small french translation
Edouard Tisserant
parents: 810
diff changeset
    97
html_theme = 'sphinxdoc'
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    98
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    99
# Theme options are theme-specific and customize the look and feel of a theme
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   100
# further.  For a list of options available for each theme, see the
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   101
# documentation.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   102
#html_theme_options = {}
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   103
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   104
# Add any paths that contain custom themes here, relative to this directory.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   105
#html_theme_path = []
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   106
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   107
# The name for this set of Sphinx documents.  If None, it defaults to
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   108
# "<project> v<release> documentation".
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   109
#html_title = None
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   110
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   111
# A shorter title for the navigation bar.  Default is the same as html_title.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   112
#html_short_title = None
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   113
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   114
# The name of an image file (relative to this directory) to place at the top
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   115
# of the sidebar.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   116
#html_logo = None
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   117
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   118
# The name of an image file (within the static path) to use as favicon of the
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   119
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   120
# pixels large.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   121
#html_favicon = None
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   122
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   123
# Add any paths that contain custom static files (such as style sheets) here,
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   124
# relative to this directory. They are copied after the builtin static files,
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   125
# so a file named "default.css" will overwrite the builtin "default.css".
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   126
html_static_path = ['_static']
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   127
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   128
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   129
# using the given strftime format.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   130
#html_last_updated_fmt = '%b %d, %Y'
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   131
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   132
# If true, SmartyPants will be used to convert quotes and dashes to
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   133
# typographically correct entities.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   134
#html_use_smartypants = True
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   135
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   136
# Custom sidebar templates, maps document names to template names.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   137
#html_sidebars = {}
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   138
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   139
# Additional templates that should be rendered to pages, maps page names to
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   140
# template names.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   141
#html_additional_pages = {}
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   142
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   143
# If false, no module index is generated.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   144
#html_domain_indices = True
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   145
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   146
# If false, no index is generated.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   147
#html_use_index = True
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   148
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   149
# If true, the index is split into individual pages for each letter.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   150
#html_split_index = False
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   151
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   152
# If true, links to the reST sources are added to the pages.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   153
#html_show_sourcelink = True
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   154
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   155
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   156
#html_show_sphinx = True
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   157
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   158
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   159
#html_show_copyright = True
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   160
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   161
# If true, an OpenSearch description file will be output, and all pages will
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   162
# contain a <link> tag referring to it.  The value of this option must be the
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   163
# base URL from which the finished HTML is served.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   164
#html_use_opensearch = ''
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   165
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   166
# This is the file name suffix for HTML files (e.g. ".xhtml").
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   167
#html_file_suffix = None
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   168
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   169
# Output file base name for HTML help builder.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   170
htmlhelp_basename = 'Beremizdoc'
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   171
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   172
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   173
# -- Options for LaTeX output --------------------------------------------------
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   174
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   175
latex_elements = {
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   176
# The paper size ('letterpaper' or 'a4paper').
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   177
#'papersize': 'letterpaper',
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   178
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   179
# The font size ('10pt', '11pt' or '12pt').
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   180
#'pointsize': '10pt',
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   181
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   182
# Additional stuff for the LaTeX preamble.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   183
#'preamble': '',
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   184
}
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   185
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   186
# Grouping the document tree into LaTeX files. List of tuples
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   187
# (source start file, target name, title, author, documentclass [howto/manual]).
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   188
latex_documents = [
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   189
  ('index', 'Beremiz.tex', u'Beremiz Documentation',
811
66a8812457d6 Added subdirectories in documentation, with more deoctree items to test. Enabled i18n in sphinx doc, tested with a small french translation
Edouard Tisserant
parents: 810
diff changeset
   190
   u'Beremiz Documentation Authors', 'manual'),
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   191
]
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   192
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   193
# The name of an image file (relative to this directory) to place at the top of
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   194
# the title page.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   195
#latex_logo = None
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   196
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   197
# For "manual" documents, if this is true, then toplevel headings are parts,
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   198
# not chapters.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   199
#latex_use_parts = False
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   200
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   201
# If true, show page references after internal links.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   202
#latex_show_pagerefs = False
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   203
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   204
# If true, show URL addresses after external links.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   205
#latex_show_urls = False
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   206
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   207
# Documents to append as an appendix to all manuals.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   208
#latex_appendices = []
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   209
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   210
# If false, no module index is generated.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   211
#latex_domain_indices = True
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   212
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   213
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   214
# -- Options for manual page output --------------------------------------------
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   215
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   216
# One entry per manual page. List of tuples
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   217
# (source start file, name, description, authors, manual section).
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   218
man_pages = [
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   219
    ('index', 'beremiz', u'Beremiz Documentation',
811
66a8812457d6 Added subdirectories in documentation, with more deoctree items to test. Enabled i18n in sphinx doc, tested with a small french translation
Edouard Tisserant
parents: 810
diff changeset
   220
     [u'Beremiz Documentation Authors'], 1)
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   221
]
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   222
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   223
# If true, show URL addresses after external links.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   224
#man_show_urls = False
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   225
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   226
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   227
# -- Options for Texinfo output ------------------------------------------------
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   228
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   229
# Grouping the document tree into Texinfo files. List of tuples
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   230
# (source start file, target name, title, author,
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   231
#  dir menu entry, description, category)
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   232
texinfo_documents = [
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   233
  ('index', 'Beremiz', u'Beremiz Documentation',
811
66a8812457d6 Added subdirectories in documentation, with more deoctree items to test. Enabled i18n in sphinx doc, tested with a small french translation
Edouard Tisserant
parents: 810
diff changeset
   234
   u'Beremiz Documentation Authors', 'Beremiz', 'One line description of project.',
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   235
   'Miscellaneous'),
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   236
]
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   237
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   238
# Documents to append as an appendix to all manuals.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   239
#texinfo_appendices = []
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   240
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   241
# If false, no module index is generated.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   242
#texinfo_domain_indices = True
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   243
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   244
# How to display URL addresses: 'footnote', 'no', or 'inline'.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   245
#texinfo_show_urls = 'footnote'