Mercurial > espworkshop

annotate conf.py @ 33:61d01865fc86 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update setup instructions.
author Radomir Dopieralski <sheep-devel@sheep.art.pl>
date Sat, 25 Jun 2016 12:47:39 +0200
parents 5050298bb041
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
1 # -*- coding: utf-8 -*-
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
2 #
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
3 # Micropython on ESP8266 Workshop documentation build configuration file, created by
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
4 # sphinx-quickstart on Wed Jun 8 21:43:59 2016.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
5 #
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
6 # This file is execfile()d with the current directory set to its
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
7 # containing dir.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
8 #
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
9 # Note that not all possible configuration values are present in this
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
10 # autogenerated file.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
11 #
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
12 # All configuration values have a default; values that are commented out
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
13 # serve to show the default.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
14
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
15 import sys
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
16 import os
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
17
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
18 # If extensions (or modules to document with autodoc) are in another directory,
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
19 # add these directories to sys.path here. If the directory is relative to the
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
20 # documentation root, use os.path.abspath to make it absolute, like shown here.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
21 #sys.path.insert(0, os.path.abspath('.'))
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
22
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
23 # -- General configuration ------------------------------------------------
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
24
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
25 # If your documentation needs a minimal Sphinx version, state it here.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
26 #needs_sphinx = '1.0'
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
27
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
28 # Add any Sphinx extension module names here, as strings. They can be
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
29 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
30 # ones.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
31 extensions = [
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
32 'sphinx.ext.pngmath',
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
33 'sphinx.ext.viewcode',
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
34 ]
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
35
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
36 # Add any paths that contain templates here, relative to this directory.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
37 templates_path = ['_templates']
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
38
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
39 # The suffix of source filenames.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
40 source_suffix = '.rst'
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
41
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
42 # The encoding of source files.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
43 #source_encoding = 'utf-8-sig'
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
44
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
45 # The master toctree document.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
46 master_doc = 'index'
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
47
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
48 # General information about the project.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
49 project = u'Micropython on ESP8266 Workshop'
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
50 copyright = u'2016, Radomir Dopieralski'
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
51
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
52 # The version info for the project you're documenting, acts as replacement for
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
53 # |version| and |release|, also used in various other places throughout the
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
54 # built documents.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
55 #
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
56 # The short X.Y version.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
57 version = '1.0'
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
58 # The full version, including alpha/beta/rc tags.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
59 release = '1.0'
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
60
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
61 # The language for content autogenerated by Sphinx. Refer to documentation
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
62 # for a list of supported languages.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
63 #language = None
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
64
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
65 # There are two options for replacing |today|: either, you set today to some
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
66 # non-false value, then it is used:
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
67 #today = ''
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
68 # Else, today_fmt is used as the format for a strftime call.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
69 #today_fmt = '%B %d, %Y'
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
70
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
71 # List of patterns, relative to source directory, that match files and
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
72 # directories to ignore when looking for source files.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
73 exclude_patterns = ['_build']
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
74
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
75 # The reST default role (used for this markup: `text`) to use for all
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
76 # documents.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
77 #default_role = None
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
78
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
79 # If true, '()' will be appended to :func: etc. cross-reference text.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
80 #add_function_parentheses = True
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
81
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
82 # If true, the current module name will be prepended to all description
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
83 # unit titles (such as .. function::).
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
84 #add_module_names = True
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
85
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
86 # If true, sectionauthor and moduleauthor directives will be shown in the
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
87 # output. They are ignored by default.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
88 #show_authors = False
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
89
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
90 # The name of the Pygments (syntax highlighting) style to use.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
91 pygments_style = 'sphinx'
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
92
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
93 # A list of ignored prefixes for module index sorting.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
94 #modindex_common_prefix = []
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
95
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
96 # If true, keep warnings as "system message" paragraphs in the built documents.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
97 #keep_warnings = False
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
98
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
99
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
100 # -- Options for HTML output ----------------------------------------------
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
101
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
102 # The theme to use for HTML and HTML Help pages. See the documentation for
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
103 # a list of builtin themes.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
104 html_theme = 'default'
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
105
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
106 # Theme options are theme-specific and customize the look and feel of a theme
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
107 # further. For a list of options available for each theme, see the
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
108 # documentation.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
109 #html_theme_options = {}
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
110
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
111 # Add any paths that contain custom themes here, relative to this directory.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
112 #html_theme_path = []
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
113
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
114 # The name for this set of Sphinx documents. If None, it defaults to
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
115 # "<project> v<release> documentation".
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
116 #html_title = None
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
117
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
118 # A shorter title for the navigation bar. Default is the same as html_title.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
119 #html_short_title = None
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
120
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
121 # The name of an image file (relative to this directory) to place at the top
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
122 # of the sidebar.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
123 #html_logo = None
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
124
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
125 # The name of an image file (within the static path) to use as favicon of the
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
126 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
127 # pixels large.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
128 #html_favicon = None
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
129
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
130 # Add any paths that contain custom static files (such as style sheets) here,
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
131 # relative to this directory. They are copied after the builtin static files,
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
132 # so a file named "default.css" will overwrite the builtin "default.css".
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
133 html_static_path = ['_static']
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
134
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
135 # Add any extra paths that contain custom files (such as robots.txt or
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
136 # .htaccess) here, relative to this directory. These files are copied
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
137 # directly to the root of the documentation.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
138 #html_extra_path = []
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
139
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
140 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
141 # using the given strftime format.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
142 #html_last_updated_fmt = '%b %d, %Y'
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
143
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
144 # If true, SmartyPants will be used to convert quotes and dashes to
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
145 # typographically correct entities.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
146 #html_use_smartypants = True
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
147
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
148 # Custom sidebar templates, maps document names to template names.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
149 #html_sidebars = {}
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
150
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
151 # Additional templates that should be rendered to pages, maps page names to
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
152 # template names.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
153 #html_additional_pages = {}
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
154
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
155 # If false, no module index is generated.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
156 #html_domain_indices = True
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
157
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
158 # If false, no index is generated.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
159 #html_use_index = True
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
160
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
161 # If true, the index is split into individual pages for each letter.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
162 #html_split_index = False
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
163
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
164 # If true, links to the reST sources are added to the pages.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
165 #html_show_sourcelink = True
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
166
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
167 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
168 #html_show_sphinx = True
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
169
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
170 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
171 #html_show_copyright = True
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
172
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
173 # If true, an OpenSearch description file will be output, and all pages will
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
174 # contain a <link> tag referring to it. The value of this option must be the
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
175 # base URL from which the finished HTML is served.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
176 #html_use_opensearch = ''
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
177
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
178 # This is the file name suffix for HTML files (e.g. ".xhtml").
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
179 #html_file_suffix = None
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
180
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
181 # Output file base name for HTML help builder.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
182 htmlhelp_basename = 'MicropythononESP8266Workshopdoc'
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
183
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
184
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
185 # -- Options for LaTeX output ---------------------------------------------
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
186
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
187 latex_elements = {
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
188 # The paper size ('letterpaper' or 'a4paper').
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
189 #'papersize': 'letterpaper',
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
190
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
191 # The font size ('10pt', '11pt' or '12pt').
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
192 #'pointsize': '10pt',
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
193
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
194 # Additional stuff for the LaTeX preamble.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
195 #'preamble': '',
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
196 }
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
197
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
198 # Grouping the document tree into LaTeX files. List of tuples
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
199 # (source start file, target name, title,
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
200 # author, documentclass [howto, manual, or own class]).
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
201 latex_documents = [
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
202 ('index', 'MicropythononESP8266Workshop.tex', u'Micropython on ESP8266 Workshop Documentation',
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
203 u'Radomir Dopieralski', 'manual'),
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
204 ]
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
205
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
206 # The name of an image file (relative to this directory) to place at the top of
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
207 # the title page.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
208 #latex_logo = None
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
209
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
210 # For "manual" documents, if this is true, then toplevel headings are parts,
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
211 # not chapters.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
212 #latex_use_parts = False
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
213
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
214 # If true, show page references after internal links.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
215 #latex_show_pagerefs = False
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
216
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
217 # If true, show URL addresses after external links.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
218 #latex_show_urls = False
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
219
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
220 # Documents to append as an appendix to all manuals.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
221 #latex_appendices = []
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
222
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
223 # If false, no module index is generated.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
224 #latex_domain_indices = True
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
225
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
226
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
227 # -- Options for manual page output ---------------------------------------
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
228
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
229 # One entry per manual page. List of tuples
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
230 # (source start file, name, description, authors, manual section).
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
231 man_pages = [
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
232 ('index', 'micropythononesp8266workshop', u'Micropython on ESP8266 Workshop Documentation',
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
233 [u'Radomir Dopieralski'], 1)
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
234 ]
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
235
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
236 # If true, show URL addresses after external links.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
237 #man_show_urls = False
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
238
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
239
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
240 # -- Options for Texinfo output -------------------------------------------
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
241
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
242 # Grouping the document tree into Texinfo files. List of tuples
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
243 # (source start file, target name, title, author,
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
244 # dir menu entry, description, category)
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
245 texinfo_documents = [
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
246 ('index', 'MicropythononESP8266Workshop', u'Micropython on ESP8266 Workshop Documentation',
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
247 u'Radomir Dopieralski', 'MicropythononESP8266Workshop', 'One line description of project.',
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
248 'Miscellaneous'),
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
249 ]
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
250
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
251 # Documents to append as an appendix to all manuals.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
252 #texinfo_appendices = []
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
253
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
254 # If false, no module index is generated.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
255 #texinfo_domain_indices = True
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
256
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
257 # How to display URL addresses: 'footnote', 'no', or 'inline'.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
258 #texinfo_show_urls = 'footnote'
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
259
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
260 # If true, do not generate a @detailmenu in the "Top" node's menu.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
261 #texinfo_no_detailmenu = False
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
262
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
263
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
264 # -- Options for Epub output ----------------------------------------------
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
265
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
266 # Bibliographic Dublin Core info.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
267 epub_title = u'Micropython on ESP8266 Workshop'
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
268 epub_author = u'Radomir Dopieralski'
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
269 epub_publisher = u'Radomir Dopieralski'
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
270 epub_copyright = u'2016, Radomir Dopieralski'
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
271
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
272 # The basename for the epub file. It defaults to the project name.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
273 #epub_basename = u'Micropython on ESP8266 Workshop'
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
274
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
275 # The HTML theme for the epub output. Since the default themes are not optimized
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
276 # for small screen space, using the same theme for HTML and epub output is
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
277 # usually not wise. This defaults to 'epub', a theme designed to save visual
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
278 # space.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
279 #epub_theme = 'epub'
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
280
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
281 # The language of the text. It defaults to the language option
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
282 # or en if the language is not set.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
283 #epub_language = ''
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
284
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
285 # The scheme of the identifier. Typical schemes are ISBN or URL.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
286 #epub_scheme = ''
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
287
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
288 # The unique identifier of the text. This can be a ISBN number
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
289 # or the project homepage.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
290 #epub_identifier = ''
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
291
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
292 # A unique identification for the text.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
293 #epub_uid = ''
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
294
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
295 # A tuple containing the cover image and cover page html template filenames.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
296 #epub_cover = ()
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
297
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
298 # A sequence of (type, uri, title) tuples for the guide element of content.opf.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
299 #epub_guide = ()
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
300
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
301 # HTML files that should be inserted before the pages created by sphinx.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
302 # The format is a list of tuples containing the path and title.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
303 #epub_pre_files = []
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
304
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
305 # HTML files shat should be inserted after the pages created by sphinx.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
306 # The format is a list of tuples containing the path and title.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
307 #epub_post_files = []
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
308
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
309 # A list of files that should not be packed into the epub file.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
310 epub_exclude_files = ['search.html']
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
311
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
312 # The depth of the table of contents in toc.ncx.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
313 #epub_tocdepth = 3
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
314
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
315 # Allow duplicate toc entries.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
316 #epub_tocdup = True
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
317
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
318 # Choose between 'default' and 'includehidden'.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
319 #epub_tocscope = 'default'
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
320
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
321 # Fix unsupported image types using the PIL.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
322 #epub_fix_images = False
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
323
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
324 # Scale large images.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
325 #epub_max_image_width = 0
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
326
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
327 # How to display URL addresses: 'footnote', 'no', or 'inline'.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
328 #epub_show_urls = 'inline'
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
329
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
330 # If false, no index is generated.
5050298bb041 Initial commit
Radomir Dopieralski <sheep-devel@sheep.art.pl>
parents:
diff changeset
331 #epub_use_index = True