doc/conf.py
author Edouard Tisserant <edouard.tisserant@gmail.com>
Mon, 16 Aug 2021 22:49:08 +0200
branchsvghmi
changeset 3294 e3db472b0dfb
parent 1878 fb73a6b6622d
child 3925 1d383b4c0a23
permissions -rw-r--r--
Runtime+SVGHMI: Added a generic way to wakeup non-real-time threads from real-time PLC thread. Replace SVGHMI specific calls in Linux and Xenomai implementations of plc_main.c. Fixed xenomai build, xeno-config making problems with --no-auto-init argument.
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
# 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
    15
# 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
    16
# documentation root, use os.path.abspath to make it absolute, like shown here.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
    17
# sys.path.insert(0, os.path.abspath('.'))
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    18
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    19
# -- General configuration -----------------------------------------------------
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
# If your documentation needs a minimal Sphinx version, state it here.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
    22
# needs_sphinx = '1.0'
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    23
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    24
# 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
    25
# 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
    26
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    27
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    28
# 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
    29
templates_path = ['_templates']
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    30
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    31
# The suffix of source filenames.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    32
source_suffix = '.rst'
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    33
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    34
# The encoding of source files.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
    35
# source_encoding = 'utf-8-sig'
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    36
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    37
# The master toctree document.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    38
master_doc = 'index'
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    39
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    40
# General information about the project.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    41
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
    42
copyright = u'is 21st century inquisition'
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    43
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    44
# 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
    45
# |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
    46
# built documents.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    47
#
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    48
# The short X.Y version.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    49
version = '1.1'
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    50
# The full version, including alpha/beta/rc tags.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    51
release = '1.1rc1'
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    52
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    53
# 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
    54
# for a list of supported languages.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
    55
# language = None
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    56
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
    57
gettext_compact = False
1746
45d6f5fba016 clean-up: fix PEP8 E202 whitespace before ')'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1732
diff changeset
    58
locale_dirs = ["locale/"]
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
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    60
# 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
    61
# non-false value, then it is used:
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
    62
# today = ''
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    63
# Else, today_fmt is used as the format for a strftime call.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
    64
# today_fmt = '%B %d, %Y'
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    65
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    66
# 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
    67
# directories to ignore when looking for source files.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    68
exclude_patterns = ['_build']
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    69
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    70
# The reST default role (used for this markup: `text`) to use for all documents.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
    71
# default_role = None
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    72
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    73
# If true, '()' will be appended to :func: etc. cross-reference text.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
    74
# add_function_parentheses = True
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    75
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    76
# 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
    77
# unit titles (such as .. function::).
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
    78
# add_module_names = True
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    79
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    80
# 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
    81
# output. They are ignored by default.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
    82
# show_authors = False
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    83
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    84
# 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
    85
pygments_style = 'sphinx'
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    86
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    87
# A list of ignored prefixes for module index sorting.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
    88
# modindex_common_prefix = []
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    89
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    90
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    91
# -- Options for HTML output ---------------------------------------------------
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
# 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
    94
# 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
    95
html_theme = 'sphinxdoc'
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    96
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
    97
# 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
    98
# 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
    99
# documentation.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   100
# html_theme_options = {}
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   101
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   102
# Add any paths that contain custom themes here, relative to this directory.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   103
# html_theme_path = []
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   104
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   105
# 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
   106
# "<project> v<release> documentation".
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   107
# html_title = None
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   108
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   109
# A shorter title for the navigation bar.  Default is the same as html_title.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   110
# html_short_title = None
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   111
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   112
# 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
   113
# of the sidebar.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   114
# html_logo = None
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   115
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   116
# 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
   117
# 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
   118
# pixels large.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   119
# html_favicon = None
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   120
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   121
# 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
   122
# 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
   123
# 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
   124
html_static_path = ['_static']
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   125
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   126
# 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
   127
# using the given strftime format.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   128
# html_last_updated_fmt = '%b %d, %Y'
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   129
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   130
# 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
   131
# typographically correct entities.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   132
# html_use_smartypants = True
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   133
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   134
# Custom sidebar templates, maps document names to template names.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   135
# html_sidebars = {}
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   136
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   137
# 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
   138
# template names.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   139
# html_additional_pages = {}
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   140
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   141
# If false, no module index is generated.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   142
# html_domain_indices = True
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   143
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   144
# If false, no index is generated.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   145
# html_use_index = True
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   146
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   147
# If true, the index is split into individual pages for each letter.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   148
# html_split_index = False
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   149
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   150
# If true, links to the reST sources are added to the pages.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   151
# html_show_sourcelink = True
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   152
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   153
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   154
# html_show_sphinx = True
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   155
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   156
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   157
# html_show_copyright = True
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   158
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   159
# 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
   160
# 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
   161
# base URL from which the finished HTML is served.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   162
# html_use_opensearch = ''
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   163
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   164
# This is the file name suffix for HTML files (e.g. ".xhtml").
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   165
# html_file_suffix = None
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   166
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   167
# Output file base name for HTML help builder.
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   168
htmlhelp_basename = 'Beremizdoc'
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   169
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   170
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   171
# -- Options for LaTeX output --------------------------------------------------
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
latex_elements = {
1776
81aa8aaccdd4 clean-up: fix PEP8 E122 continuation line missing indentation or outdented
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1746
diff changeset
   174
    # The paper size ('letterpaper' or 'a4paper').
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   175
    # 'papersize': 'letterpaper',
1776
81aa8aaccdd4 clean-up: fix PEP8 E122 continuation line missing indentation or outdented
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1746
diff changeset
   176
81aa8aaccdd4 clean-up: fix PEP8 E122 continuation line missing indentation or outdented
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1746
diff changeset
   177
    # The font size ('10pt', '11pt' or '12pt').
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   178
    # 'pointsize': '10pt',
1776
81aa8aaccdd4 clean-up: fix PEP8 E122 continuation line missing indentation or outdented
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1746
diff changeset
   179
81aa8aaccdd4 clean-up: fix PEP8 E122 continuation line missing indentation or outdented
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1746
diff changeset
   180
    # Additional stuff for the LaTeX preamble.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   181
    # 'preamble': '',
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   182
}
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   183
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   184
# 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
   185
# (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
   186
latex_documents = [
1878
fb73a6b6622d fix pylint warning '(bad-continuation) Wrong hanging indentation before block'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
   187
    ('index', 'Beremiz.tex', u'Beremiz Documentation',
fb73a6b6622d fix pylint warning '(bad-continuation) Wrong hanging indentation before block'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
   188
     u'Beremiz Documentation Authors', 'manual'),
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   189
]
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   190
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   191
# 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
   192
# the title page.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   193
# latex_logo = None
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   194
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   195
# 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
   196
# not chapters.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   197
# latex_use_parts = False
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   198
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   199
# If true, show page references after internal links.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   200
# latex_show_pagerefs = False
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   201
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   202
# If true, show URL addresses after external links.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   203
# latex_show_urls = False
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   204
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   205
# Documents to append as an appendix to all manuals.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   206
# latex_appendices = []
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   207
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   208
# If false, no module index is generated.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   209
# latex_domain_indices = True
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   210
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   211
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   212
# -- Options for manual page output --------------------------------------------
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
# One entry per manual page. List of tuples
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   215
# (source start file, name, description, authors, manual section).
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   216
man_pages = [
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   217
    ('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
   218
     [u'Beremiz Documentation Authors'], 1)
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   219
]
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   220
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   221
# If true, show URL addresses after external links.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   222
# man_show_urls = False
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   223
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   224
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   225
# -- Options for Texinfo output ------------------------------------------------
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
# 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
   228
# (source start file, target name, title, author,
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   229
#  dir menu entry, description, category)
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   230
texinfo_documents = [
1878
fb73a6b6622d fix pylint warning '(bad-continuation) Wrong hanging indentation before block'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
   231
    ('index', 'Beremiz', u'Beremiz Documentation',
fb73a6b6622d fix pylint warning '(bad-continuation) Wrong hanging indentation before block'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
   232
     u'Beremiz Documentation Authors', 'Beremiz', 'One line description of project.',
fb73a6b6622d fix pylint warning '(bad-continuation) Wrong hanging indentation before block'
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1850
diff changeset
   233
     'Miscellaneous'),
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   234
]
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   235
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   236
# Documents to append as an appendix to all manuals.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   237
# texinfo_appendices = []
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   238
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   239
# If false, no module index is generated.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   240
# texinfo_domain_indices = True
810
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   241
707e2be17a43 Added sphinx doc root in /doc. To be continued
Edouard Tisserant
parents:
diff changeset
   242
# How to display URL addresses: 'footnote', 'no', or 'inline'.
1782
5b6ad7a7fd9d clean-up: fix PEP8 E265 block comment should start with '# '
Andrey Skvortsov <andrej.skvortzov@gmail.com>
parents: 1776
diff changeset
   243
# texinfo_show_urls = 'footnote'