配置¶
The configuration directory must contain a file named conf.py
.
This file (containing Python code) is called the “build configuration file”
and contains (almost) all configuration needed to customize Sphinx input
and output behavior.
An optional file docutils.conf can be added to the configuration directory to adjust Docutils configuration if not otherwise overridden or set by Sphinx.
The configuration file is executed as Python code at build time (using
execfile()
, and with the current directory set to its containing
directory), and therefore can execute arbitrarily complex code. Sphinx then
reads simple names from the file’s namespace as its configuration.
重点要注意:
If not otherwise documented, values must be strings, and their default is the empty string.
The term “fully-qualified name” refers to a string that names an importable Python object inside a module; for example, the FQN
"sphinx.builders.Builder"
means theBuilder
class in thesphinx.builders
module.Remember that document names use
/
as the path separator and don’t contain the file name extension.Since
conf.py
is read as a Python file, the usual rules apply for encodings and Unicode support.The contents of the config namespace are pickled (so that Sphinx can find out when configuration changes), so it may not contain unpickleable values – delete them from the namespace with
del
if appropriate. Modules are removed automatically, so you don’t need todel
your imports after use.
项目信息¶
-
project
¶ 记录的项目名称。
该文件的作者姓名。 默认值为
unknown
.
-
copyright
¶ 2008, Author Name
风格的版权声明.
-
version
¶ 主要项目版本，用作
| version |
的替代品。 例如，对于Python文档，这可能类似于2.6
。
一般配置项¶
-
extensions
¶ A list of strings that are module names of extensions. These can be extensions coming with Sphinx (named
sphinx.ext.*
) or custom ones.Note that you can extend
sys.path
within the conf file if your extensions live in another directory – but make sure you use absolute paths. If your extension path is relative to the configuration directory, useos.path.abspath()
like so:import sys, os sys.path.append(os.path.abspath('sphinxext')) extensions = ['extname']
That way, you can load an extension called
extname
from the subdirectorysphinxext
.The configuration file itself can be an extension; for that, you only need to provide a
setup()
function in it.
-
source_suffix
¶ The file extensions of source files. Sphinx considers the files with this suffix as sources. The value can be a dictionary mapping file extensions to file types. For example:
source_suffix = { '.rst': 'restructuredtext', '.txt': 'restructuredtext', '.md': 'markdown', }
By default, Sphinx only supports
'restructuredtext'
file type. You can add a new file type using source parser extensions. Please read a document of the extension to know which file type the extension supports.The value may also be a list of file extensions: then Sphinx will consider that they all map to the
'restructuredtext'
file type.Default is
{'.rst': 'restructuredtext'}
.注解
文件扩展名必须以点开头 (e.g.
.rst
).在 1.3 版更改: 现在可以是扩展名列表。
在 1.8 版更改: 支持文件类型映射
-
source_encoding
¶ The encoding of all reST source files. The recommended encoding, and the default value, is
'utf-8-sig'
.0.5 新版功能: Previously, Sphinx accepted only UTF-8 encoded sources.
-
source_parsers
¶ If given, a dictionary of parser classes for different source suffices. The keys are the suffix, the values can be either a class or a string giving a fully-qualified name of a parser class. The parser class can be either
docutils.parsers.Parser
orsphinx.parsers.Parser
. Files with a suffix that is not in the dictionary will be parsed with the default reStructuredText parser.例如:
source_parsers = {'.md': 'recommonmark.parser.CommonMarkParser'}
注解
Refer to Markdown for more information on using Markdown with Sphinx.
1.3 新版功能.
1.8 版后已移除: Now Sphinx provides an API
Sphinx.add_source_parser()
to register a source parser. Please use it instead.
-
master_doc
¶ The document name of the “master” document, that is, the document that contains the root
toctree
directive. Default is'index'
.在 2.0 版更改: The default is changed to
'index'
from'contents'
.
-
exclude_patterns
¶ A list of glob-style patterns that should be excluded when looking for source files. 1 They are matched against the source file names relative to the source directory, using slashes as directory separators on all platforms.
Example patterns:
'library/xml.rst'
– ignores thelibrary/xml.rst
file (replaces entry inunused_docs
)'library/xml'
– ignores thelibrary/xml
directory'library/xml*'
– ignores all files and directories starting withlibrary/xml
'**/.svn'
– ignores all.svn
directories
exclude_patterns
is also consulted when looking for static files inhtml_static_path
andhtml_extra_path
.1.0 新版功能.
-
templates_path
¶ A list of paths that contain extra templates (or templates that overwrite builtin/theme-specific templates). Relative paths are taken as relative to the configuration directory.
在 1.3 版更改: As these files are not meant to be built, they are automatically added to
exclude_patterns
.
-
template_bridge
¶ A string with the fully-qualified name of a callable (or simply a class) that returns an instance of
TemplateBridge
. This instance is then used to render HTML documents, and possibly the output of other builders (currently the changes builder). (Note that the template bridge must be made theme-aware if HTML themes are to be used.)
-
rst_epilog
¶ A string of reStructuredText that will be included at the end of every source file that is read. This is a possible place to add substitutions that should be available in every file (another being
rst_prolog
). An example:rst_epilog = """ .. |psf| replace:: Python Software Foundation """
0.6 新版功能.
-
rst_prolog
¶ A string of reStructuredText that will be included at the beginning of every source file that is read. This is a possible place to add substitutions that should be available in every file (another being
rst_epilog
). An example:rst_prolog = """ .. |psf| replace:: Python Software Foundation """
1.0 新版功能.
-
primary_domain
¶ The name of the default domain. Can also be
None
to disable a default domain. The default is'py'
. Those objects in other domains (whether the domain name is given explicitly, or selected by adefault-domain
directive) will have the domain name explicitly prepended when named (e.g., when the default domain is C, Python functions will be named “Python function”, not just “function”).1.0 新版功能.
-
default_role
¶ The name of a reST role (builtin or Sphinx extension) to use as the default role, that is, for text marked up
`like this`
. This can be set to'py:obj'
to make`filter`
a cross-reference to the Python function “filter”. The default isNone
, which doesn’t reassign the default role.The default role can always be set within individual documents using the standard reST
default-role
directive.0.4 新版功能.
-
keep_warnings
¶ If true, keep warnings as “system message” paragraphs in the built documents. Regardless of this setting, warnings are always written to the standard error stream when
sphinx-build
is run.The default is
False
, the pre-0.5 behavior was to always keep them.0.5 新版功能.
-
suppress_warnings
¶ A list of warning types to suppress arbitrary warning messages.
Sphinx支持以下警告类型:
app.add_node
app.add_directive
app.add_role
app.add_generic_role
app.add_source_parser
download.not_readable
image.not_readable
ref.term
ref.ref
ref.numref
ref.keyword
ref.option
ref.citation
ref.footnote
ref.doc
ref.python
misc.highlighting_failure
toc.secnum
epub.unknown_project_files
You can choose from these types.
Now, this option should be considered experimental.
1.4 新版功能.
在 1.5 版更改: Added
misc.highlighting_failure
在 1.5.1 版更改: Added
epub.unknown_project_files
在 1.6 版更改: Added
ref.footnote
-
needs_sphinx
¶ If set to a
major.minor
version string like'1.1'
, Sphinx will compare it with its version and refuse to build if it is too old. Default is no requirement.1.0 新版功能.
在 1.4 版更改: also accepts micro version string
-
needs_extensions
¶ This value can be a dictionary specifying version requirements for extensions in
extensions
, e.g.needs_extensions = {'sphinxcontrib.something': '1.5'}
. The version strings should be in the formmajor.minor
. Requirements do not have to be specified for all extensions, only for those you want to check.This requires that the extension specifies its version to Sphinx (see 为Sphinx开发扩展 for how to do that).
1.3 新版功能.
-
manpages_url
¶ A URL to cross-reference
manpage
directives. If this is defined tohttps://manpages.debian.org/{path}
, the:manpage:`man(1)`
role will link to <https://manpages.debian.org/man(1)>. The patterns available are:page
- the manual page (man
)section
- the manual section (1
)path
- the original manual page and section specified (man(1)
)
This also supports manpages specified as
man.1
.注解
This currently affects only HTML writers but could be expanded in the future.
1.7 新版功能.
-
nitpicky
¶ If true, Sphinx will warn about all references where the target cannot be found. Default is
False
. You can activate this mode temporarily using the-n
command-line switch.1.0 新版功能.
-
nitpick_ignore
¶ A list of
(type, target)
tuples (by default empty) that should be ignored when generating warnings in “nitpicky mode”. Note thattype
should include the domain name if present. Example entries would be('py:func', 'int')
or('envvar', 'LD_LIBRARY_PATH')
.1.1 新版功能.
-
numfig
¶ If true, figures, tables and code-blocks are automatically numbered if they have a caption. The
numref
role is enabled. Obeyed so far only by HTML and LaTeX builders. Default isFalse
.注解
The LaTeX builder always assigns numbers whether this option is enabled or not.
1.3 新版功能.
-
numfig_format
¶ A dictionary mapping
'figure'
,'table'
,'code-block'
and'section'
to strings that are used for format of figure numbers. As a special character,%s
will be replaced to figure number.Default is to use
'Fig. %s'
for'figure'
,'Table %s'
for'table'
,'Listing %s'
for'code-block'
and'Section'
for'section'
.1.3 新版功能.
-
numfig_secnum_depth
¶ if set to
0
, figures, tables and code-blocks are continuously numbered starting at1
.if
1
(default) numbers will bex.1
,x.2
, … withx
the section number (top level sectioning; nox.
if no section). This naturally applies only if section numbering has been activated via the:numbered:
option of thetoctree
directive.2
means that numbers will bex.y.1
,x.y.2
, … if located in a sub-section (but stillx.1
,x.2
, … if located directly under a section and1
,2
, … if not in any top level section.)etc…
1.3 新版功能.
在 1.7 版更改: The LaTeX builder obeys this setting (if
numfig
is set toTrue
).
-
smartquotes
¶ If true, the Docutils Smart Quotes transform, originally based on SmartyPants (limited to English) and currently applying to many languages, will be used to convert quotes and dashes to typographically correct entities. Default:
True
.1.6.6 新版功能: It replaces deprecated
html_use_smartypants
. It applies by default to all builders exceptman
andtext
(seesmartquotes_excludes
.)A docutils.conf file located in the configuration directory (or a global
~/.docutils
file) is obeyed unconditionally if it deactivates smart quotes via the corresponding Docutils option. But if it activates them, thensmartquotes
does prevail.
-
smartquotes_action
¶ This string, for use with Docutils
0.14
or later, customizes the Smart Quotes transform. See the filesmartquotes.py
at the Docutils repository for details. The default'qDe'
educates normal quote characters"
,'
, em- and en-Dashes---
,--
, and ellipses...
.1.6.6 新版功能.
-
smartquotes_excludes
¶ This is a
dict
whose default is:{'languages': ['ja'], 'builders': ['man', 'text']}
Each entry gives a sufficient condition to ignore the
smartquotes
setting and deactivate the Smart Quotes transform. Accepted keys are as above'builders'
or'languages'
. The values are lists.注解
Currently, in case of invocation of make with multiple targets, the first target name is the only one which is tested against the
'builders'
entry and it decides for all. Also, amake text
followingmake html
needs to be issued in the formmake text O="-E"
to force re-parsing of source files, as the cached ones are already transformed. On the other hand the issue does not arise with direct usage of sphinx-build as it caches (in its default usage) the parsed source files in per builder locations.1.6.6 新版功能.
-
tls_verify
¶ If true, Sphinx verifies server certifications. Default is
True
.1.5 新版功能.
-
tls_cacerts
¶ A path to a certification file of CA or a path to directory which contains the certificates. This also allows a dictionary mapping hostname to the path to certificate file. The certificates are used to verify server certifications.
1.5 新版功能.
小技巧
Sphinx uses requests as a HTTP library internally. Therefore, Sphinx refers a certification file on the directory pointed
REQUESTS_CA_BUNDLE
environment variable iftls_cacerts
not set.
-
today
¶ -
today_fmt
¶ These values determine how to format the current date, used as the replacement for
|today|
.If you set
today
to a non-empty value, it is used.Otherwise, the current time is formatted using
time.strftime()
and the format given intoday_fmt
.
The default is now
today
and atoday_fmt
of'%B %d, %Y'
(or, if translation is enabled withlanguage
, an equivalent format for the selected locale).
-
highlight_language
¶ The default language to highlight source code in. The default is
'python3'
. The value should be a valid Pygments lexer name, see Showing code examples for more details.0.5 新版功能.
在 1.4 版更改: The default is now
'default'
. It is similar to'python3'
; it is mostly a superset of'python'
but it fallbacks to'none'
without warning if failed.'python3'
and other languages will emit warning if failed. If you prefer Python 2 only highlighting, you can set it back to'python'
.
-
highlight_options
¶ A dictionary of options that modify how the lexer specified by
highlight_language
generates highlighted source code. These are lexer-specific; for the options understood by each, see the Pygments documentation.1.3 新版功能.
-
pygments_style
¶ The style name to use for Pygments highlighting of source code. If not set, either the theme’s default style or
'sphinx'
is selected for HTML output.在 0.3 版更改: If the value is a fully-qualified name of a custom Pygments style class, this is then used as custom style.
-
add_function_parentheses
¶ A boolean that decides whether parentheses are appended to function and method role text (e.g. the content of
:func:`input`
) to signify that the name is callable. Default isTrue
.
-
add_module_names
¶ A boolean that decides whether module names are prepended to all object names (for object types where a “module” of some kind is defined), e.g. for
py:function
directives. Default isTrue
.
A boolean that decides whether
codeauthor
andsectionauthor
directives produce any output in the built files.
-
modindex_common_prefix
¶ A list of prefixes that are ignored for sorting the Python module index (e.g., if this is set to
['foo.']
, thenfoo.bar
is shown underB
, notF
). This can be handy if you document a project that consists of a single package. Works only for the HTML builder currently. Default is[]
.0.6 新版功能.
-
trim_footnote_reference_space
¶ Trim spaces before footnote references that are necessary for the reST parser to recognize the footnote, but do not look too nice in the output.
0.6 新版功能.
-
trim_doctest_flags
¶ If true, doctest flags (comments looking like
# doctest: FLAG, ...
) at the ends of lines and<BLANKLINE>
markers are removed for all code blocks showing interactive Python sessions (i.e. doctests). Default isTrue
. See the extensiondoctest
for more possibilities of including doctests.1.0 新版功能.
在 1.1 版更改: 现在也删除了
<BLANKLINE>
.
国际化选项¶
这些选项会影响Sphinx的 母语支持 。有关详细信息，请参阅以下文档 国际化。
-
language
¶ 文档编写语言的代码。Sphinx自动生成的任何文本都将使用该语言。此外，Sphinx将尝试使用以下内容替换您文档中的各个段落
locale_dirs
。Sphinx将搜索由 figure_language_filename 命名的语言特定数字，并将其替换为原始数字。在LaTeX构建器中，将选择合适的语言作为 Babel 包的选项。默认为None
，这意味着不会进行任何翻译。0.5 新版功能.
在 1.4 版更改: 支持数字替换
目前Sphinx支持的语言是:
bn
– 孟加拉语ca
– 加泰罗尼亚语cs
– 捷克语da
– 丹麦语de
– 德语en
– 英语es
– 西班牙语et
– 爱沙尼亚语eu
– 巴斯克语fa
– 伊朗语fi
– 芬兰语fr
– 法语he
– 希伯来语hr
– 克罗地亚语hu
– 匈牙利语id
– 印度尼西亚语it
– 意大利语ja
– 日语ko
– 朝鲜语lt
– 立陶宛语lv
– 拉脱维亚语mk
– 马其顿语nb_NO
– 挪威博克马尔语ne
– 尼泊尔语nl
– 荷兰语pl
– 波兰语pt_BR
– 巴西葡萄牙语pt_PT
– 欧洲葡萄牙语ru
– 俄语si
– 僧伽罗语sk
– 斯洛伐克语sl
– 斯洛文尼亚语sv
– 瑞典语tr
– 土耳其语uk_UA
– 乌克兰语vi
– 越南语zh_CN
– 简体中文zh_TW
– 繁体中文
-
locale_dirs
¶ 0.5 新版功能.
相对于源目录，在其中搜索其他消息目录（请参阅
language
）的目录。此路径上的目录由标准gettext
模块搜索。Internal messages are fetched from a text domain of
sphinx
; so if you add the directory./locale
to this setting, the message catalogs (compiled from.po
format using msgfmt) must be in./locale/language/LC_MESSAGES/sphinx.mo
. The text domain of individual documents depends ongettext_compact
.The default is
['locales']
.在 1.5 版更改: Use
locales
directory as a default value
-
gettext_compact
¶ 1.1 新版功能.
If true, a document’s text domain is its docname if it is a top-level project file and its very base directory otherwise.
By default, the document
markup/code.rst
ends up in themarkup
text domain. With this option set toFalse
, it ismarkup/code
.
-
gettext_uuid
¶ If true, Sphinx generates uuid information for version tracking in message catalogs. It is used for:
Add uid line for each msgids in .pot files.
Calculate similarity between new msgids and previously saved old msgids. This calculation takes a long time.
If you want to accelerate the calculation, you can use
python-levenshtein
3rd-party package written in C by using pip install python-levenshtein.The default is
False
.1.3 新版功能.
-
gettext_location
¶ If true, Sphinx generates location information for messages in message catalogs.
The default is
True
.1.3 新版功能.
-
gettext_auto_build
¶ If true, Sphinx builds mo file for each translation catalog files.
The default is
True
.1.3 新版功能.
-
gettext_additional_targets
¶ To specify names to enable gettext extracting and translation applying for i18n additionally. You can specify below names:
- Index
index terms
- Literal-block
literal blocks:
::
andcode-block
.- Doctest-block
doctest block
- Raw
raw content
- Image
image/figure uri and alt
For example:
gettext_additional_targets = ['literal-block', 'image']
.The default is
[]
.1.3 新版功能.
-
figure_language_filename
¶ The filename format for language-specific figures. The default value is
{root}.{language}{ext}
. It will be expanded todirname/filename.en.png
from.. image:: dirname/filename.png
. The available format tokens are:{root}
- the filename, including any path component, without the file extension, e.g.dirname/filename
{path}
- the directory path component of the filename, with a trailing slash if non-empty, e.g.dirname/
{basename}
- the filename without the directory path or file extension components, e.g.filename
{ext}
- the file extension, e.g..png
{language}
- the translation language, e.g.en
For example, setting this to
{path}{language}/{basename}{ext}
will expand todirname/en/filename.png
instead.1.4 新版功能.
在 1.5 版更改: Added
{path}
and{basename}
tokens.
数学的选项¶
These options influence Math notations.
-
math_number_all
¶ Set this option to
True
if you want all displayed math to be numbered. The default isFalse
.
-
math_eqref_format
¶ A string used for formatting the labels of references to equations. The
{number}
place-holder stands for the equation number.Example:
'Eq.{number}'
gets rendered as, for example,Eq.10
.
-
math_numfig
¶ If
True
, displayed math equations are numbered across pages whennumfig
is enabled. Thenumfig_secnum_depth
setting is respected. Theeq
, notnumref
, role must be used to reference equation numbers. Default isTrue
.1.7 新版功能.
HTML输出选项¶
These options influence HTML as well as HTML Help output, and other builders that use Sphinx’s HTMLWriter class.
-
html_theme
¶ The “theme” that the HTML output should use. See the section about theming. The default is
'alabaster'
.0.6 新版功能.
-
html_theme_options
¶ A dictionary of options that influence the look and feel of the selected theme. These are theme-specific. For the options understood by the builtin themes, see this section.
0.6 新版功能.
-
html_theme_path
¶ A list of paths that contain custom themes, either as subdirectories or as zip files. Relative paths are taken as relative to the configuration directory.
0.6 新版功能.
-
html_style
¶ The style sheet to use for HTML pages. A file of that name must exist either in Sphinx’s
static/
path, or in one of the custom paths given inhtml_static_path
. Default is the stylesheet given by the selected theme. If you only want to add or override a few things compared to the theme’s stylesheet, use CSS@import
to import the theme’s stylesheet.
-
html_title
¶ The “title” for HTML documentation generated with Sphinx’s own templates. This is appended to the
<title>
tag of individual pages, and used in the navigation bar as the “topmost” element. It defaults to'<project> v<revision> documentation'
.
-
html_short_title
¶ A shorter “title” for the HTML docs. This is used in for links in the header and in the HTML Help docs. If not given, it defaults to the value of
html_title
.0.4 新版功能.
-
html_baseurl
¶ The URL which points to the root of the HTML documentation. It is used to indicate the location of document like
canonical_url
.1.8 新版功能.
-
html_context
¶ A dictionary of values to pass into the template engine’s context for all pages. Single values can also be put in this dictionary using the
-A
command-line option ofsphinx-build
.0.5 新版功能.
-
html_logo
¶ If given, this must be the name of an image file (path relative to the configuration directory) that is the logo of the docs. It is placed at the top of the sidebar; its width should therefore not exceed 200 pixels. Default:
None
.0.4.1 新版功能: The image file will be copied to the
_static
directory of the output HTML, but only if the file does not already exist there.
-
html_favicon
¶ If given, this must be the name of an image file (path relative to the configuration directory) that is the favicon of the docs. Modern browsers use this as the icon for tabs, windows and bookmarks. It should be a Windows-style icon file (
.ico
), which is 16x16 or 32x32 pixels large. Default:None
.0.4 新版功能: The image file will be copied to the
_static
directory of the output HTML, but only if the file does not already exist there.
-
html_css_files
¶ A list of CSS files. The entry must be a filename string or a tuple containing the filename string and the attributes dictionary. The filename must be relative to the
html_static_path
, or a full URI with scheme likehttp://example.org/style.css
. The attributes is used for attributes of<link>
tag. It defaults to an empty list.Example:
html_css_files = ['custom.css' 'https://example.com/css/custom.css', ('print.css', {'media': 'print'})]
1.8 新版功能.
-
html_js_files
¶ A list of JavaScript filename. The entry must be a filename string or a tuple containing the filename string and the attributes dictionary. The filename must be relative to the
html_static_path
, or a full URI with scheme likehttp://example.org/script.js
. The attributes is used for attributes of<script>
tag. It defaults to an empty list.Example:
html_js_files = ['script.js', 'https://example.com/scripts/custom.js', ('custom.js', {'async': 'async'})]
1.8 新版功能.
-
html_static_path
¶ A list of paths that contain custom static files (such as style sheets or script files). Relative paths are taken as relative to the configuration directory. They are copied to the output’s
_static
directory after the theme’s static files, so a file nameddefault.css
will overwrite the theme’sdefault.css
.As these files are not meant to be built, they are automatically excluded from source files.
注解
For security reasons, dotfiles under
html_static_path
will not be copied. If you would like to copy them intentionally, please add each filepath to this setting:html_static_path = ['_static', '_static/.htaccess']
Another way to do that, you can also use
html_extra_path
. It allows to copy dotfiles under the directories.在 0.4 版更改: The paths in
html_static_path
can now contain subdirectories.在 1.0 版更改: The entries in
html_static_path
can now be single files.在 1.8 版更改: The files under
html_static_path
are excluded from source files.
-
html_extra_path
¶ A list of paths that contain extra files not directly related to the documentation, such as
robots.txt
or.htaccess
. Relative paths are taken as relative to the configuration directory. They are copied to the output directory. They will overwrite any existing file of the same name.As these files are not meant to be built, they are automatically excluded from source files.
1.2 新版功能.
在 1.4 版更改: The dotfiles in the extra directory will be copied to the output directory. And it refers
exclude_patterns
on copying extra files and directories, and ignores if path matches to patterns.
-
html_last_updated_fmt
¶ If this is not None, a ‘Last updated on:’ timestamp is inserted at every page bottom, using the given
strftime()
format. The empty string is equivalent to'%b %d, %Y'
(or a locale-dependent equivalent).
-
html_use_smartypants
¶ If true, quotes and dashes are converted to typographically correct entities. Default:
True
.1.6 版后已移除: To disable smart quotes, use rather
smartquotes
.
-
html_add_permalinks
¶ Sphinx will add “permalinks” for each heading and description environment as paragraph signs that become visible when the mouse hovers over them.
This value determines the text for the permalink; it defaults to
"¶"
. Set it toNone
or the empty string to disable permalinks.0.6 新版功能: Previously, this was always activated.
在 1.1 版更改: This can now be a string to select the actual text of the link. Previously, only boolean values were accepted.
Custom sidebar templates, must be a dictionary that maps document names to template names.
The keys can contain glob-style patterns 1, in which case all matching documents will get the specified sidebars. (A warning is emitted when a more than one glob-style pattern matches for any document.)
The values can be either lists or single strings.
If a value is a list, it specifies the complete list of sidebar templates to include. If all or some of the default sidebars are to be included, they must be put into this list as well.
The default sidebars (for documents that don’t match any pattern) are defined by theme itself. Builtin themes are using these templates by default:
['localtoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html']
.If a value is a single string, it specifies a custom sidebar to be added between the
'sourcelink.html'
and'searchbox.html'
entries. This is for compatibility with Sphinx versions before 1.0.
1.7 版后已移除: a single string value for
html_sidebars
will be removed in 2.0Builtin sidebar templates that can be rendered are:
localtoc.html – a fine-grained table of contents of the current document
globaltoc.html – a coarse-grained table of contents for the whole documentation set, collapsed
relations.html – two links to the previous and next documents
sourcelink.html – a link to the source of the current document, if enabled in
html_show_sourcelink
searchbox.html – the “quick search” box
Example:
html_sidebars = { '**': ['globaltoc.html', 'sourcelink.html', 'searchbox.html'], 'using/windows': ['windowssidebar.html', 'searchbox.html'], }
This will render the custom template
windowssidebar.html
and the quick search box within the sidebar of the given document, and render the default sidebars for all other pages (except that the local TOC is replaced by the global TOC).1.0 新版功能: The ability to use globbing keys and to specify multiple sidebars.
Note that this value only has no effect if the chosen theme does not possess a sidebar, like the builtin scrolls and haiku themes.
-
html_additional_pages
¶ Additional templates that should be rendered to HTML pages, must be a dictionary that maps document names to template names.
Example:
html_additional_pages = { 'download': 'customdownload.html', }
This will render the template
customdownload.html
as the pagedownload.html
.
-
html_domain_indices
¶ If true, generate domain-specific indices in addition to the general index. For e.g. the Python domain, this is the global module index. Default is
True
.This value can be a bool or a list of index names that should be generated. To find out the index name for a specific index, look at the HTML file name. For example, the Python module index has the name
'py-modindex'
.1.0 新版功能.
-
html_use_index
¶ If true, add an index to the HTML documents. Default is
True
.0.4 新版功能.
-
html_split_index
¶ If true, the index is generated twice: once as a single page with all the entries, and once as one page per starting letter. Default is
False
.0.4 新版功能.
-
html_copy_source
¶ If true, the reST sources are included in the HTML build as
_sources/name
. The default isTrue
.
-
html_show_sourcelink
¶ If true (and
html_copy_source
is true as well), links to the reST sources will be added to the sidebar. The default isTrue
.0.6 新版功能.
-
html_sourcelink_suffix
¶ Suffix to be appended to source links (see
html_show_sourcelink
), unless they have this suffix already. Default is'.txt'
.1.5 新版功能.
-
html_use_opensearch
¶ If nonempty, an OpenSearch description file will be output, and all pages will contain a
<link>
tag referring to it. Since OpenSearch doesn’t support relative URLs for its search page location, the value of this option must be the base URL from which these documents are served (without trailing slash), e.g."https://docs.python.org"
. The default is''
.
-
html_file_suffix
¶ This is the file name suffix for generated HTML files. The default is
".html"
.0.4 新版功能.
-
html_link_suffix
¶ Suffix for generated links to HTML files. The default is whatever
html_file_suffix
is set to; it can be set differently (e.g. to support different web server setups).0.6 新版功能.
-
html_show_copyright
¶ If true, “(C) Copyright …” is shown in the HTML footer. Default is
True
.1.0 新版功能.
-
html_show_sphinx
¶ If true, “Created using Sphinx” is shown in the HTML footer. Default is
True
.0.4 新版功能.
-
html_output_encoding
¶ Encoding of HTML output files. Default is
'utf-8'
. Note that this encoding name must both be a valid Python encoding name and a valid HTMLcharset
value.1.0 新版功能.
-
html_compact_lists
¶ If true, a list all whose items consist of a single paragraph and/or a sub-list all whose items etc… (recursive definition) will not use the
<p>
element for any of its items. This is standard docutils behavior. Default:True
.1.0 新版功能.
-
html_secnumber_suffix
¶ Suffix for section numbers. Default:
". "
. Set to" "
to suppress the final dot on section numbers.1.0 新版功能.
-
html_search_language
¶ Language to be used for generating the HTML full-text search index. This defaults to the global language selected with
language
. If there is no support for this language,"en"
is used which selects the English language.Support is present for these languages:
da
– 丹麦语nl
– 荷兰语en
– 英语fi
– 芬兰语fr
– 法语de
– 德语hu
– 匈牙利语it
– 意大利语ja
– 日语no
– Norwegianpt
– Portuguesero
– Romanianru
– 俄语es
– 西班牙语sv
– 瑞典语tr
– 土耳其语zh
– Chinese
1.1 新版功能: With support for
en
andja
.在 1.3 版更改: Added additional languages.
-
html_search_options
¶ A dictionary with options for the search language support, empty by default. The meaning of these options depends on the language selected.
The English support has no options.
The Japanese support has these options:
- Type
type is dotted module path string to specify Splitter implementation which should be derived from
sphinx.search.ja.BaseSplitter
. If not specified or None is specified,'sphinx.search.ja.DefaultSplitter'
will be used.You can choose from these modules:
- ‘sphinx.search.ja.DefaultSplitter’
TinySegmenter algorithm. This is default splitter.
- ‘sphinx.search.ja.MecabSplitter’
MeCab binding. To use this splitter, ‘mecab’ python binding or dynamic link library (‘libmecab.so’ for linux, ‘libmecab.dll’ for windows) is required.
- ‘sphinx.search.ja.JanomeSplitter’
Janome binding. To use this splitter, Janome is required.
1.6 版后已移除:
'mecab'
,'janome'
and'default'
is deprecated. To keep compatibility,'mecab'
,'janome'
and'default'
are also acceptable.
Other option values depend on splitter value which you choose.
- ‘’‘mecab’``的选项:
- dic_enc
dic_enc option is the encoding for the MeCab algorithm.
- dict
dict option is the dictionary to use for the MeCab algorithm.
- lib
lib option is the library name for finding the MeCab library via ctypes if the Python binding is not installed.
例如:
html_search_options = { 'type': 'mecab', 'dic_enc': 'utf-8', 'dict': '/path/to/mecab.dic', 'lib': '/path/to/libmecab.so', }
- ‘’‘janome’``的选项:
- user_dic
user_dic option is the user dictionary file path for Janome.
- user_dic_enc
user_dic_enc option is the encoding for the user dictionary file specified by
user_dic
option. Default is ‘utf8’.
1.1 新版功能.
在 1.4 版更改: html_search_options for Japanese is re-organized and any custom splitter can be used by type settings.
The Chinese support has these options:
dict
– thejieba
dictionary path if want to use custom dictionary.
-
html_search_scorer
¶ The name of a JavaScript file (relative to the configuration directory) that implements a search results scorer. If empty, the default will be used.
1.2 新版功能.
-
html_scaled_image_link
¶ If true, images itself links to the original image if it doesn’t have ‘target’ option or scale related options: ‘scale’, ‘width’, ‘height’. The default is
True
.1.3 新版功能.
-
html_math_renderer
¶ The name of math_renderer extension for HTML output. The default is
'mathjax'
.1.8 新版功能.
-
html_experimental_html5_writer
¶ Output is processed with HTML5 writer. This feature needs docutils 0.13 or newer. Default is
False
.1.6 新版功能.
2.0 版后已移除.
-
html4_writer
¶ Output is processed with HTML4 writer. Default is
False
.
单个HTML输出的选项¶
Custom sidebar templates, must be a dictionary that maps document names to template names. And it only allows a key named ‘index’. All other keys are ignored. For more information, refer to
html_sidebars
. By default, it is same ashtml_sidebars
.
HTML帮助输出选项¶
-
htmlhelp_basename
¶ Output file base name for HTML help builder. Default is
'pydoc'
.
-
htmlhelp_file_suffix
¶ This is the file name suffix for generated HTML help files. The default is
".html"
.2.0 新版功能.
-
htmlhelp_link_suffix
¶ Suffix for generated links to HTML files. The default is
".html"
.2.0 新版功能.
Apple帮助输出选项¶
1.3 新版功能.
These options influence the Apple Help output. This builder derives from the HTML builder, so the HTML options also apply where appropriate.
注解
Apple Help output will only work on Mac OS X 10.6 and higher, as it requires the hiutil and codesign command line tools, neither of which are Open Source.
You can disable the use of these tools using
applehelp_disable_external_tools
, but the result will not be a
valid help book until the indexer is run over the .lproj
folders within
the bundle.
-
applehelp_bundle_id
¶ The bundle ID for the help book bundle.
警告
You must set this value in order to generate Apple Help.
-
applehelp_dev_region
¶ The development region. Defaults to
'en-us'
, which is Apple’s recommended setting.
-
applehelp_bundle_version
¶ The bundle version (as a string). Defaults to
'1'
.
-
applehelp_icon
¶ The help bundle icon file, or
None
for no icon. According to Apple’s documentation, this should be a 16-by-16 pixel version of the application’s icon with a transparent background, saved as a PNG file.
-
applehelp_kb_product
¶ The product tag for use with
applehelp_kb_url
. Defaults to'<project>-<release>'
.
-
applehelp_kb_url
¶ The URL for your knowledgebase server, e.g.
https://example.com/kbsearch.py?p='product'&q='query'&l='lang'
. Help Viewer will replace the values'product'
,'query'
and'lang'
at runtime with the contents ofapplehelp_kb_product
, the text entered by the user in the search box and the user’s system language respectively.Defaults to
None
for no remote search.
-
applehelp_remote_url
¶ The URL for remote content. You can place a copy of your Help Book’s
Resources
folder at this location and Help Viewer will attempt to use it to fetch updated content.e.g. if you set it to
https://example.com/help/Foo/
and Help Viewer wants a copy ofindex.html
for an English speaking customer, it will look athttps://example.com/help/Foo/en.lproj/index.html
.Defaults to
None
for no remote content.
-
applehelp_index_anchors
¶ If
True
, tell the help indexer to index anchors in the generated HTML. This can be useful for jumping to a particular topic using theAHLookupAnchor
function or theopenHelpAnchor:inBook:
method in your code. It also allows you to usehelp:anchor
URLs; see the Apple documentation for more information on this topic.
-
applehelp_min_term_length
¶ Controls the minimum term length for the help indexer. Defaults to
None
, which means the default will be used.
-
applehelp_stopwords
¶ Either a language specification (to use the built-in stopwords), or the path to a stopwords plist, or
None
if you do not want to use stopwords. The default stopwords plist can be found at/usr/share/hiutil/Stopwords.plist
and contains, at time of writing, stopwords for the following languages:Language
Code
English
en
German
de
Spanish
es
French
fr
Swedish
sv
Hungarian
hu
Italian
it
Defaults to
language
, or if that is not set, toen
.
-
applehelp_locale
¶ Specifies the locale to generate help for. This is used to determine the name of the
.lproj
folder inside the Help Book’sResources
, and is passed to the help indexer.Defaults to
language
, or if that is not set, toen
.
-
applehelp_title
¶ Specifies the help book title. Defaults to
'<project> Help'
.
-
applehelp_codesign_identity
¶ Specifies the identity to use for code signing, or
None
if code signing is not to be performed.Defaults to the value of the environment variable
CODE_SIGN_IDENTITY
, which is set by Xcode for script build phases, orNone
if that variable is not set.
-
applehelp_codesign_flags
¶ A list of additional arguments to pass to codesign when signing the help book.
Defaults to a list based on the value of the environment variable
OTHER_CODE_SIGN_FLAGS
, which is set by Xcode for script build phases, or the empty list if that variable is not set.
-
applehelp_indexer_path
¶ The path to the hiutil program. Defaults to
'/usr/bin/hiutil'
.
-
applehelp_codesign_path
¶ The path to the codesign program. Defaults to
'/usr/bin/codesign'
.
-
applehelp_disable_external_tools
¶ If
True
, the builder will not run the indexer or the code signing tool, no matter what other settings are specified.This is mainly useful for testing, or where you want to run the Sphinx build on a non-Mac OS X platform and then complete the final steps on OS X for some reason.
Defaults to
False
.
epub输出的选项¶
These options influence the epub output. As this builder derives from the HTML builder, the HTML options also apply where appropriate. The actual values for some of the options is not really important, they just have to be entered into the Dublin Core metadata.
-
epub_theme
¶ The HTML theme for the epub output. Since the default themes are not optimized for small screen space, using the same theme for HTML and epub output is usually not wise. This defaults to
'epub'
, a theme designed to save visual space.
-
epub_theme_options
¶ A dictionary of options that influence the look and feel of the selected theme. These are theme-specific. For the options understood by the builtin themes, see this section.
1.2 新版功能.
-
epub_title
¶ The title of the document. It defaults to the
html_title
option but can be set independently for epub creation. It defaults to theproject
option.在 2.0 版更改: It defaults to the
project
option.
-
epub_description
¶ The description of the document. The default value is
'unknown'
.1.4 新版功能.
在 1.5 版更改: Renamed from
epub3_description
The author of the document. This is put in the Dublin Core metadata. It defaults to the
author
option.
-
epub_contributor
¶ The name of a person, organization, etc. that played a secondary role in the creation of the content of an EPUB Publication. The default value is
'unknown'
.1.4 新版功能.
在 1.5 版更改: Renamed from
epub3_contributor
-
epub_language
¶ The language of the document. This is put in the Dublin Core metadata. The default is the
language
option or'en'
if unset.
-
epub_publisher
¶ The publisher of the document. This is put in the Dublin Core metadata. You may use any sensible string, e.g. the project homepage. The defaults to the
author
option.
-
epub_copyright
¶ The copyright of the document. It defaults to the
copyright
option but can be set independently for epub creation.
-
epub_identifier
¶ An identifier for the document. This is put in the Dublin Core metadata. For published documents this is the ISBN number, but you can also use an alternative scheme, e.g. the project homepage. The default value is
'unknown'
.
-
epub_scheme
¶ The publication scheme for the
epub_identifier
. This is put in the Dublin Core metadata. For published books the scheme is'ISBN'
. If you use the project homepage,'URL'
seems reasonable. The default value is'unknown'
.
-
epub_uid
¶ A unique identifier for the document. This is put in the Dublin Core metadata. You may use a XML’s Name format string. You can’t use hyphen, period, numbers as a first character. The default value is
'unknown'
.
-
epub_cover
¶ The cover page information. This is a tuple containing the filenames of the cover image and the html template. The rendered html cover page is inserted as the first item in the spine in
content.opf
. If the template filename is empty, no html cover page is created. No cover at all is created if the tuple is empty. Examples:epub_cover = ('_static/cover.png', 'epub-cover.html') epub_cover = ('_static/cover.png', '') epub_cover = ()
The default value is
()
.1.1 新版功能.
-
epub_css_files
¶ A list of CSS files. The entry must be a filename string or a tuple containing the filename string and the attributes dictionary. For more information, see
html_css_files
.1.8 新版功能.
-
epub_guide
¶ Meta data for the guide element of
content.opf
. This is a sequence of tuples containing the type, the uri and the title of the optional guide information. See the OPF documentation at http://idpf.org/epub for details. If possible, default entries for the cover and toc types are automatically inserted. However, the types can be explicitly overwritten if the default entries are not appropriate. Example:epub_guide = (('cover', 'cover.html', u'Cover Page'),)
The default value is
()
.
-
epub_pre_files
¶ Additional files that should be inserted before the text generated by Sphinx. It is a list of tuples containing the file name and the title. If the title is empty, no entry is added to
toc.ncx
. Example:epub_pre_files = [ ('index.html', 'Welcome'), ]
The default value is
[]
.
-
epub_post_files
¶ Additional files that should be inserted after the text generated by Sphinx. It is a list of tuples containing the file name and the title. This option can be used to add an appendix. If the title is empty, no entry is added to
toc.ncx
. The default value is[]
.
-
epub_exclude_files
¶ A list of files that are generated/copied in the build directory but should not be included in the epub file. The default value is
[]
.
-
epub_tocdepth
¶ The depth of the table of contents in the file
toc.ncx
. It should be an integer greater than zero. The default value is 3. Note: A deeply nested table of contents may be difficult to navigate.
-
epub_tocdup
¶ This flag determines if a toc entry is inserted again at the beginning of its nested toc listing. This allows easier navigation to the top of a chapter, but can be confusing because it mixes entries of different depth in one list. The default value is
True
.
-
epub_tocscope
¶ This setting control the scope of the epub table of contents. The setting can have the following values:
'default'
– include all toc entries that are not hidden (default)'includehidden'
– include all toc entries
1.2 新版功能.
-
epub_fix_images
¶ This flag determines if sphinx should try to fix image formats that are not supported by some epub readers.  You need Pillow, the Python Image Library, installed to use this option. The default value is
False
because the automatic conversion may lose information.1.2 新版功能.
-
epub_max_image_width
¶ This option specifies the maximum width of images. If it is set to a value greater than zero, images with a width larger than the given value are scaled accordingly. If it is zero, no scaling is performed. The default value is
0
. You need the Python Image Library (Pillow) installed to use this option.1.2 新版功能.
-
epub_show_urls
¶ Control whether to display URL addresses. This is very useful for readers that have no other means to display the linked URL. The settings can have the following values:
'inline'
– display URLs inline in parentheses (default)'footnote'
– display URLs in footnotes'no'
– do not display URLs
The display of inline URLs can be customized by adding CSS rules for the class
link-target
.1.2 新版功能.
-
epub_use_index
¶ If true, add an index to the epub document. It defaults to the
html_use_index
option but can be set independently for epub creation.1.2 新版功能.
-
epub_writing_mode
¶ It specifies writing direction. It can accept
'horizontal'
(default) and'vertical'
epub_writing_mode
'horizontal'
'vertical'
writing-mode 2
horizontal-tb
vertical-rl
page progression
left to right
right to left
iBook’s Scroll Theme support
scroll-axis is vertical.
scroll-axis is horizontal.
LaTeX输出的选项¶
These options influence LaTeX output.
-
latex_engine
¶ The LaTeX engine to build the docs. The setting can have the following values:
'pdflatex'
– PDFLaTeX (default)'xelatex'
– XeLaTeX'lualatex'
– LuaLaTeX'platex'
– pLaTeX (default iflanguage
is'ja'
)
'pdflatex'
’s support for Unicode characters is limited.注解
2.0 adds to
'pdflatex'
support in Latin language document of occasional Cyrillic or Greek letters or words. This is not automatic, see the discussion of thelatex_elements
'fontenc'
key.If your project uses Unicode characters, setting the engine to
'xelatex'
or'lualatex'
and making sure to use an OpenType font with wide-enough glyph coverage is often easier than trying to make'pdflatex'
work with the extra Unicode characters. Since Sphinx 2.0 the default is the GNU FreeFont which covers well Latin, Cyrillic and Greek.Contrarily to MathJaX math rendering in HTML output, LaTeX requires some extra configuration to support Unicode literals in
math
: the only comprehensive solution (as far as we know) is to use'xelatex'
or'lualatex'
and to addr'\usepackage{unicode-math}'
(e.g. via thelatex_elements
'preamble'
key). You may preferr'\usepackage[math-style=literal]{unicode-math}'
to keep a Unicode literal such asα
(U+03B1) for example as is in output, rather than being rendered as \(\alpha\).
-
latex_documents
¶ This value determines how to group the document tree into LaTeX source files. It must be a list of tuples
(startdocname, targetname, title, author, documentclass, toctree_only)
, where the items are:- startdocname
String that specifies the document name of the LaTeX file’s master document. All documents referenced by the startdoc document in TOC trees will be included in the LaTeX file. (If you want to use the default master document for your LaTeX build, provide your
master_doc
here.)- targetname
File name of the LaTeX file in the output directory.
- title
LaTeX document title. Can be empty to use the title of the startdoc document. This is inserted as LaTeX markup, so special characters like a backslash or ampersand must be represented by the proper LaTeX commands if they are to be inserted literally.
- author
Author for the LaTeX document. The same LaTeX markup caveat as for title applies. Use
\\and
to separate multiple authors, as in:'John \\and Sarah'
(backslashes must be Python-escaped to reach LaTeX).- documentclass
Normally, one of
'manual'
or'howto'
(provided by Sphinx and based on'report'
, resp.'article'
; Japanese documents use'jsbook'
, resp.'jreport'
.) “howto” (non-Japanese) documents will not get appendices. Also they have a simpler title page. Other document classes can be given. Independently of the document class, the “sphinx” package is always loaded in order to define Sphinx’s custom LaTeX commands.- toctree_only
Must be
True
orFalse
. If true, the startdoc document itself is not included in the output, only the documents referenced by it via TOC trees. With this option, you can put extra stuff in the master document that shows up in the HTML, but not the LaTeX output.
1.2 新版功能: In the past including your own document class required you to prepend the document class name with the string “sphinx”. This is not necessary anymore.
0.3 新版功能: The 6th item
toctree_only
. Tuples with 5 items are still accepted.
-
latex_logo
¶ If given, this must be the name of an image file (relative to the configuration directory) that is the logo of the docs. It is placed at the top of the title page. Default:
None
.
-
latex_toplevel_sectioning
¶ This value determines the topmost sectioning unit. It should be chosen from
'part'
,'chapter'
or'section'
. The default isNone
; the topmost sectioning unit is switched by documentclass:section
is used if documentclass will behowto
, otherwisechapter
will be used.Note that if LaTeX uses
\part
command, then the numbering of sectioning units one level deep gets off-sync with HTML numbering, because LaTeX numbers continuously\chapter
(or\section
forhowto
.)1.4 新版功能.
-
latex_appendices
¶ A list of document names to append as an appendix to all manuals.
-
latex_domain_indices
¶ If true, generate domain-specific indices in addition to the general index. For e.g. the Python domain, this is the global module index. Default is
True
.This value can be a bool or a list of index names that should be generated, like for
html_domain_indices
.1.0 新版功能.
-
latex_show_pagerefs
¶ If true, add page references after internal references. This is very useful for printed copies of the manual. Default is
False
.1.0 新版功能.
-
latex_show_urls
¶ Control whether to display URL addresses. This is very useful for printed copies of the manual. The setting can have the following values:
'no'
– do not display URLs (default)'footnote'
– display URLs in footnotes'inline'
– display URLs inline in parentheses
1.0 新版功能.
在 1.1 版更改: This value is now a string; previously it was a boolean value, and a true value selected the
'inline'
display. For backwards compatibility,True
is still accepted.
-
latex_use_latex_multicolumn
¶ The default is
False
: it means that Sphinx’s own macros are used for merged cells from grid tables. They allow general contents (literal blocks, lists, blockquotes, …) but may have problems if thetabularcolumns
directive was used to inject LaTeX mark-up of the type>{..}
,<{..}
<EMAIL_ADDRESS>as column specification.Setting to
True
means to use LaTeX’s standard\multicolumn
; this is incompatible with literal blocks in the horizontally merged cell, and also with multiple paragraphs in such cell if the table is rendered usingtabulary
.1.6 新版功能.
-
latex_use_xindy
¶ If
True
, the PDF build from the LaTeX files created by Sphinx will use xindy (doc) rather than makeindex for preparing the index of general terms (fromindex
usage). This means that words with UTF-8 characters will get ordered correctly for thelanguage
.This option is ignored if
latex_engine
is'platex'
(Japanese documents; mendex replaces makeindex then).The default is
True
for'xelatex'
or'lualatex'
as makeindex, if any indexed term starts with a non-ascii character, creates.ind
files containing invalid bytes for UTF-8 encoding. With'lualatex'
this then breaks the PDF build.The default is
False
for'pdflatex'
butTrue
is recommended for non-English documents as soon as some indexed terms use non-ascii characters from the language script.
Sphinx adds to xindy base distribution some dedicated support for using
'pdflatex'
engine with Cyrillic scripts. And whether with'pdflatex'
or Unicode engines, Cyrillic documents handle correctly the indexing of Latin names, even with diacritics.1.8 新版功能.
-
latex_elements
¶ 0.5 新版功能.
Its documentation has moved to LaTeX 定制.
-
latex_docclass
¶ A dictionary mapping
'howto'
and'manual'
to names of real document classes that will be used as the base for the two Sphinx classes. Default is to use'article'
for'howto'
and'report'
for'manual'
.1.0 新版功能.
在 1.5 版更改: In Japanese docs (
language
is'ja'
), by default'jreport'
is used for'howto'
and'jsbook'
for'manual'
.
-
latex_additional_files
¶ A list of file names, relative to the configuration directory, to copy to the build directory when building LaTeX output. This is useful to copy files that Sphinx doesn’t copy automatically, e.g. if they are referenced in custom LaTeX added in
latex_elements
. Image files that are referenced in source files (e.g. via.. image::
) are copied automatically.You have to make sure yourself that the filenames don’t collide with those of any automatically copied files.
0.6 新版功能.
在 1.2 版更改: This overrides the files which is provided from Sphinx such as
sphinx.sty
.
文本输出选项¶
These options influence text output.
-
text_newlines
¶ Determines which end-of-line character(s) are used in text output.
'unix'
: use Unix-style line endings (\n
)'windows'
: use Windows-style line endings (\r\n
)'native'
: use the line ending style of the platform the documentation is built on
Default:
'unix'
.1.1 新版功能.
-
text_sectionchars
¶ A string of 7 characters that should be used for underlining sections. The first character is used for first-level headings, the second for second-level headings and so on.
The default is
'*=-~"+`'
.1.1 新版功能.
-
text_add_secnumbers
¶ A boolean that decides whether section numbers are included in text output. Default is
True
.1.7 新版功能.
-
text_secnumber_suffix
¶ Suffix for section numbers in text output. Default:
". "
. Set to" "
to suppress the final dot on section numbers.1.7 新版功能.
手动页面输出选项¶
These options influence manual page output.
-
man_pages
¶ This value determines how to group the document tree into manual pages. It must be a list of tuples
(startdocname, name, description, authors, section)
, where the items are:- startdocname
String that specifies the document name of the manual page’s master document. All documents referenced by the startdoc document in TOC trees will be included in the manual file. (If you want to use the default master document for your manual pages build, use your
master_doc
here.)- name
Name of the manual page. This should be a short string without spaces or special characters. It is used to determine the file name as well as the name of the manual page (in the NAME section).
- description
Description of the manual page. This is used in the NAME section.
- authors
A list of strings with authors, or a single string. Can be an empty string or list if you do not want to automatically generate an AUTHORS section in the manual page.
- section
The manual page section. Used for the output file name as well as in the manual page header.
1.0 新版功能.
-
man_show_urls
¶ If true, add URL addresses after links. Default is
False
.1.1 新版功能.
Texinfo输出的选项¶
These options influence Texinfo output.
-
texinfo_documents
¶ This value determines how to group the document tree into Texinfo source files. It must be a list of tuples
(startdocname, targetname, title, author, dir_entry, description, category, toctree_only)
, where the items are:- startdocname
String that specifies the document name of the the Texinfo file’s master document. All documents referenced by the startdoc document in TOC trees will be included in the Texinfo file. (If you want to use the default master document for your Texinfo build, provide your
master_doc
here.)- targetname
File name (no extension) of the Texinfo file in the output directory.
- title
Texinfo document title. Can be empty to use the title of the startdoc document. Inserted as Texinfo markup, so special characters like
@
and{}
will need to be escaped to be inserted literally.- author
Author for the Texinfo document. Inserted as Texinfo markup. Use
@*
to separate multiple authors, as in:'John@*Sarah'
.- dir_entry
The name that will appear in the top-level
DIR
menu file.- description
Descriptive text to appear in the top-level
DIR
menu file.- category
Specifies the section which this entry will appear in the top-level
DIR
menu file.- toctree_only
Must be
True
orFalse
. If true, the startdoc document itself is not included in the output, only the documents referenced by it via TOC trees. With this option, you can put extra stuff in the master document that shows up in the HTML, but not the Texinfo output.
1.1 新版功能.
-
texinfo_appendices
¶ A list of document names to append as an appendix to all manuals.
1.1 新版功能.
-
texinfo_domain_indices
¶ If true, generate domain-specific indices in addition to the general index. For e.g. the Python domain, this is the global module index. Default is
True
.This value can be a bool or a list of index names that should be generated, like for
html_domain_indices
.1.1 新版功能.
-
texinfo_show_urls
¶ Control how to display URL addresses.
'footnote'
– display URLs in footnotes (default)'no'
– do not display URLs'inline'
– display URLs inline in parentheses
1.1 新版功能.
If true, do not generate a
@detailmenu
in the “Top” node’s menu containing entries for each sub-node in the document. Default isFalse
.1.2 新版功能.
-
texinfo_elements
¶ A dictionary that contains Texinfo snippets that override those Sphinx usually puts into the generated
.texi
files.Keys that you may want to override include:
'paragraphindent'
Number of spaces to indent the first line of each paragraph, default
2
. Specify0
for no indentation.'exampleindent'
Number of spaces to indent the lines for examples or literal blocks, default
4
. Specify0
for no indentation.'preamble'
Texinfo markup inserted near the beginning of the file.
'copying'
Texinfo markup inserted within the
@copying
block and displayed after the title. The default value consists of a simple title page identifying the project.
Keys that are set by other options and therefore should not be overridden are:
'author'
'body'
'date'
'direntry'
'filename'
'project'
'release'
'title'
1.1 新版功能.
QtHelp输出的选项¶
These options influence qthelp output. As this builder derives from the HTML builder, the HTML options also apply where appropriate.
-
qthelp_namespace
¶ The namespace for the qthelp file. It defaults to
org.sphinx.<project_name>.<project_version>
.
-
qthelp_theme
¶ The HTML theme for the qthelp output. This defaults to
'nonav'
.
-
qthelp_theme_options
¶ A dictionary of options that influence the look and feel of the selected theme. These are theme-specific. For the options understood by the builtin themes, see this section.
linkcheck构建器的选项¶
-
linkcheck_ignore
¶ A list of regular expressions that match URIs that should not be checked when doing a
linkcheck
build. Example:linkcheck_ignore = [r'http://localhost:\d+/']
1.1 新版功能.
-
linkcheck_retries
¶ The number of times the linkcheck builder will attempt to check a URL before declaring it broken. Defaults to 1 attempt.
1.4 新版功能.
-
linkcheck_timeout
¶ A timeout value, in seconds, for the linkcheck builder. The default is to use Python’s global socket timeout.
1.1 新版功能.
-
linkcheck_workers
¶ The number of worker threads to use when checking links. Default is 5 threads.
1.1 新版功能.
-
linkcheck_anchors
¶ If true, check the validity of
#anchor
s in links. Since this requires downloading the whole document, it’s considerably slower when enabled. Default isTrue
.1.2 新版功能.
-
linkcheck_anchors_ignore
¶ A list of regular expressions that match anchors Sphinx should skip when checking the validity of anchors in links. This allows skipping anchors that a website’s JavaScript adds to control dynamic pages or when triggering an internal REST request. Default is
["^!"]
.注解
If you want to ignore anchors of a specific page or of pages that match a specific pattern (but still check occurrences of the same page(s) that don’t have anchors), use
linkcheck_ignore
instead, for example as follows:linkcheck_ignore = [ 'http://www.sphinx-doc.org/en/1.7/intro.html#' ]
1.5 新版功能.
C++ 域选项¶
-
cpp_index_common_prefix
¶ A list of prefixes that will be ignored when sorting C++ objects in the global index. For example
['awesome_lib::']
.1.5 新版功能.
-
cpp_id_attributes
¶ A list of strings that the parser additionally should accept as attributes. This can for example be used when attributes have been
#define
d for portability.1.5 新版功能.
-
cpp_paren_attributes
¶ A list of strings that the parser additionally should accept as attributes with one argument. That is, if
my_align_as
is in the list, thenmy_align_as(X)
is parsed as an attribute for all stringsX
that have balanced braces (()
,[]
, and{}
). This can for example be used when attributes have been#define
d for portability.1.5 新版功能.
配置文件示例¶
# test documentation build configuration file, created by
# sphinx-quickstart on Sun Jun 26 00:00:43 2016.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
# The encoding of source files.
#
# source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'test'
copyright = u'2016, test'
author = u'test'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = u'test'
# The full version, including alpha/beta/rc tags.
release = u'test'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#
# today = ''
#
# Else, today_fmt is used as the format for a strftime call.
#
# today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# These patterns also affect html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# The reST default role (used for this markup: `text`) to use for all
# documents.
#
# default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#
# add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#
# add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#
# show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
# keep_warnings = False
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
# The name for this set of Sphinx documents.
# "<project> v<release> documentation" by default.
#
# html_title = u'test vtest'
# A shorter title for the navigation bar. Default is the same as html_title.
#
# html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#
# html_logo = None
# The name of an image file (relative to this directory) to use as a favicon of
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#
# html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#
# html_extra_path = []
# If not None, a 'Last updated on:' timestamp is inserted at every page
# bottom, using the given strftime format.
# The empty string is equivalent to '%b %d, %Y'.
#
# html_last_updated_fmt = None
# Custom sidebar templates, maps document names to template names.
#
# html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#
# html_additional_pages = {}
# If false, no module index is generated.
#
# html_domain_indices = True
# If false, no index is generated.
#
# html_use_index = True
# If true, the index is split into individual pages for each letter.
#
# html_split_index = False
# If true, links to the reST sources are added to the pages.
#
# html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#
# html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#
# html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#
# html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = None
# Language to be used for generating the HTML full-text search index.
# Sphinx supports the following languages:
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
#
# html_search_language = 'en'
# A dictionary with options for the search language support, empty by default.
# 'ja' uses this config value.
# 'zh' user can custom change `jieba` dictionary path.
#
# html_search_options = {'type': 'default'}
# The name of a javascript file (relative to the configuration directory) that
# implements a search results scorer. If empty, the default will be used.
#
# html_search_scorer = 'scorer.js'
# Output file base name for HTML help builder.
htmlhelp_basename = 'testdoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'test.tex', u'test Documentation',
u'test', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#
# latex_logo = None
# If true, show page references after internal links.
#
# latex_show_pagerefs = False
# If true, show URL addresses after external links.
#
# latex_show_urls = False
# Documents to append as an appendix to all manuals.
#
# latex_appendices = []
# If false, no module index is generated.
#
# latex_domain_indices = True
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'test', u'test Documentation',
[author], 1)
]
# If true, show URL addresses after external links.
#
# man_show_urls = False
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'test', u'test Documentation',
author, 'test', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#
# texinfo_appendices = []
# If false, no module index is generated.
#
# texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#
# texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#
# texinfo_no_detailmenu = False
# -- A random example -----------------------------------------------------
import sys, os
sys.path.insert(0, os.path.abspath('.'))
exclude_patterns = ['zzz']
numfig = True
#language = 'ja'
extensions.append('sphinx.ext.todo')
extensions.append('sphinx.ext.autodoc')
#extensions.append('sphinx.ext.autosummary')
extensions.append('sphinx.ext.intersphinx')
extensions.append('sphinx.ext.mathjax')
extensions.append('sphinx.ext.viewcode')
extensions.append('sphinx.ext.graphviz')
autosummary_generate = True
html_theme = 'default'
#source_suffix = ['.rst', '.txt']


| 021:073 Khan | : |
And We made them leaders, guiding (mankind) by Our Command, and We inspired in them the doing of good deeds, performing Salat (Iqamat-as-Salat), and the giving of Zakat and of Us (Alone) they were worshippers. |
| 021:073 Maulana | : |
And We made them leaders who guided (people) by Our command, and We revealed to them the doing of good and the keeping up of prayer and the giving of alms, and Us (alone) they served; |
| 021:073 Pickthal | : |
And We made them chiefs who guide by Our command, and We inspired in them the doing of good deeds and the right establishment of worship and the giving of alms, and they were worshippers of Us (alone). |
| 021:073 Rashad | : |
We made them imams who guided in accordance with our commandments, and we taught them how to work righteousness, and how to observe the Contact Prayers (Salat) and the obligatory charity (Zakat). To us, they were devoted worshipers. |
| 021:073 Sarwar | : |
We appointed them as leaders to guide the people through Our command and sent them revelation to strive for good deeds, worship their Lord, and pay religious tax. Both of them were Our worshipping servants. |
| 021:073 Shakir | : |
And We made them Imams who guided (people) by Our command, and We revealed to them the doing of good and the keeping up of prayer and the giving of the alms, and Us (alone) did they serve; |
| 021:073 Sherali | : |
And WE made them leaders who guided people by Our command, and WE sent revelation to them enjoining the doing of good works, and the observance of Prayer, and the giving of alms. And US alone they worshiped. |
| 021:073 Yusufali | : |
And We made them leaders, guiding (men) by Our Command, and We sent them inspiration to do good deeds, to establish regular prayers, and to practise regular charity; and they constantly served Us (and Us only). |
Concepts/Themes Covered: أركان الإسلام > الصلاة > أداء الصلاة > الحض عليها Pillars of Islam> The Prayers>Performing the Prayers> The Incitement to Pray أركان الإسلام > الزكاة والصدقات Pillars of Islam> Due Alms and Charities تنظيم العلاقات المالية > الزكاة Organizing Financial Relationships>Due Alms
This tool uses eight English parallel translations for the Holy Quran imported from Mr. Clay Smith. You can also visit Qurany Concepts for browsing the Quran themes or topics. If you want to search the Holy Quran for keywords, please visit Qurany Keywords.


[viewBag] title = "Engineering" url = "/for-organisations/kiron-study-tracks/engineering" layout = "title-text-static" is_hidden = 0 navigation_hidden = 0 robot_index = "index" robot_follow = "follow" ==
The Kiron Engineering Study Track lets our students acquire the knowledge of scientific and technical fundamentals in different fields of engineering and teaches an engineering approach to solving real-life problems. Upon completion of the core modules within the engineering field of their choice, they can choose to specialize in different subjects and target a specific Mechanical, Electrical, Civil, Chemical or Environmental Engineering degree at a partner university.
Key Learning Outcomes
Kiron’s Engineering Study Tracks start with scientific fundamentals in subjects such as mathematics, physics and chemistry. These are followed by more technical foundations required for the specific engineering field of their choice. They cover subjects such as mechanics, materials science, thermodynamics, electronics, or geotechnology. Interdisciplinary skills in project management, quality management and law are also covered to different extents in the engineering curricula.
After successfully completing one of the engineering tracks, our students will
have gained the fundamental skills and mindset that any engineer must have in the first place,
be able to analyze real-world problems and approach them analytically,


| Partner Name | Partner Id | Partner Description | Phone Number | Partner Server Address | Email Address | Modify | Remove |
|---|---|---|---|---|---|---|---|
| {{entries.partnerName}} | {{entries.partnerId}} | {{entries.partnerDescription}} | {{entries.phoneNumber}} | {{entries.serverAddress}} | {{entries.emailAddress}} | Modify | Remove |


Concrete Random
Those with my learning style tend to like experimenting to learn. Tinkering with or tweaking code little by little is what helps me solve problems. We learn best when we can use trial and error approaches, and we tend to work best on our own. For us, working in a routine, keeping detailed records, and restrictions are the enemy when is comes to work.
Here at DBC, my biggest struggle is being faced with routines. At the current moment my schedule isn't very stable, so I never know when I'm going to have time to sit and code, or study, or peer pair. My learning style doesn't have anything to do with this, though. And it's something I need to work on. However, my learning style does make it hard for me to follow steps as asked by some challenges. For example, wireframing. Oh, wireframing. It's like English class (my best subject, mind you) when I was always asked to outline my essay. It always frustrated me, because even if I'm the one creating the structure - I don't like following a structure. My mind tends to come up with the best ideas in the heat of the moment. So I always end up deviating from the outline anyway! This proves difficult when following challege guidelines, sometimes.
I've been told I don't have the mind for certain things. Including coding. But it's something I enjoy, and I want to learn. I will craft the mind that's needed to code. That's why we're all here, right? My ability to learn is not static. It will grow with determination and help from DBC. When you struggle, what feels better? Giving up or finally getting where you wanted to go? I may struggle, but the part of my mind that drives me is driving me in the direction to become a great developer.
Dev Bootcamp: Kitchen vs. Table
This experience is just beginning. It's new. But so far I've learned a lot not just about coding, but about myself. I'm the type of student that fears I'm further behind than everyone else. My biggest fear here is definitely that I do not know enough to keep up with my peers. But I also know that I can learn. I have the ability to catch up, even if it's in a different way than others. I know I can be at the same level as everyone else - especially because I'm with DBC. I have peers and mentors who will help me. This program provides me with all the tools I need to strive as long as I put in all my effort. I won't lie - I'm nervous. Very. I'm nervous about moving forward without the knowledge I need to succeed. My expectations are high for DBC - and therefore, high for me as well.


Session Title Abstract visible to attendees Abstract Preview Speaker Level Category Tags ; Notes to Reviewer (not visible to attendees) Session Length 60 Minutes 30 Minutes Level Category Selected Tags (Click to Remove) All Tags (Click to Add or Remove) - OR - New Tag


My Favorite Places
These are my favorite places
Crater Lake
For more information about Crater Lake:
Crater Lake Info
Portland
Sunriver
Mount Hood


There is a good chance a test suite for XMLHttpRequest will be placed around here. Along with implementation reports.


Adds brute force and multiple starting values to nls.
| Version: | 0.2 |
| Depends: | proto |
| Suggests: | nlstools |
| Published: | 2013-03-08 |
| Author: | G. Grothendieck |
| Maintainer: | G. Grothendieck <ggrothendieck at gmail.com> |
| BugReports: | http://groups.google.com/group/sqldf |
| License: | GPL-2 |
| URL: | http://nls2.googlecode.com |
| NeedsCompilation: | no |
| Materials: | NEWS |
| In views: | Optimization |
| CRAN checks: | nls2 results |
| Reference manual: | nls2.pdf |
| Package source: | nls2_0.2.tar.gz |
| Windows binaries: | r-devel: nls2_0.2.zip, r-release: nls2_0.2.zip, r-oldrel: nls2_0.2.zip |
| OS X binaries: | r-release: nls2_0.2.tgz, r-oldrel: nls2_0.2.tgz |
| Old sources: | nls2 archive |
| Reverse imports: | BAT, beezdemand, mstherm |
Please use the canonical form https://CRAN.R-project.org/package=nls2 to link to this page.


break
Exit a while() or for() loop.
continue
Jump back to the beginning of a while() or for() loop.
else {
All commands inside an else block are executed if the expression in the earlier if block is false.
for (i = 0; i < 10; i++) {
All commands inside a for loop block are repeatedly executed.
function doSomething() {
Defines a list of commands as function which can be called.
if (expression) {
All commands inside an if block are only executed if expression is true.
macro "title" {
Macro sets can be defined to make reusable macro available via ImageJs menu, the toolbar or via shortcuts. See documentation for more details.
print("\\Clear")
Empty the log window.
print("\\Update:[text]")
Update the recent line of the log window by replace its content by [text].
print("\\Update[n]:[text]")
Update the [n+1]th line of the log window by replace its content by [text].
var
The var
statement allows defining global variables which are available from different macros. See documentation for more details.
while (expression) {
All commands inside a while loop block are repeatedly executed until expression becomes false.


ANGULARJS ASSIGNMENT
Employee Details
id
name
email
dob
company Name
{{ employee.address}}
{{ employee.name}}
{{ employee.email}}
{{employee.dob}}
{{employee.companyName}}
ADD MORE EMPLOYEES


Boto supports Python versions 2.6, 2.7, 3.3, and 3.4. Python 3 support is on a per-module basis. This guide will help you to get started porting a Boto module to Python 3.
Please read the Contributing Guide before getting started.
Boto ships with a boto.compat module that helps to abstract the differences between Python versions. A vendored version of the six module is exposed through boto.compat.six, as well as a handful of moved functions used throughout the codebase:
# Import the six module
from boto.compat import six
# Other useful imports
from boto.compat import BytesIO, StringIO
from boto.compat import http_client
from boto.compat import urlparse
Please check the boto.compat module before writing your own logic around specialized behavior for different Python versions. Feel free to add new functionality here, too.
Please follow the following steps when porting a module:
Install Python versions and pip install tox
Port your module to support Python 3. These help:
Whitelist your module’s unit tests in tests/test.py
Make sure unit tests pass by running tox
Try running integration tests:
tox tests/integration/yourmodule
# You can also run against a specific Python version:
tox -e py26 tests/integration/yourmodule
Fix any failing tests. This is the fun part!
If code you modified is not covered by tests, try to cover it with existing tests or write new tests. Here is how you can generate a coverage report in cover/index.html:
# Run a test with coverage
tox -e py33 -- default --with-coverage --cover-html --cover-package boto
Update README.rst and docs/source/index.rst to label your module as supporting Python 3
Submit a pull request!
Note: We try our best to clean up resources after a test runs, but you should double check that no resources are left after integration tests run. If they are, then you will be charged for them!


Automated Evaluation of Answers using ML
Instructions
Read question carefully before answering.
All questions are compulsory and have equal weightage.
Q) {{ question_text[0] }}
Q) {{ question_text[1] }}
Q) {{ question_text[2] }}
Q) {{ question_text[3] }}
Q) {{ question_text[4] }}


Can you rate the quality of simplified sentences in English?
Information Sheet
We invite fluent English speakers to participate in an experiment on rating the quality of simplified sentences.
Before you decide to participate, it is important that you understand the purpose of the research
you will be participating in and what will happen to the data collected from you.
The study aims to collect ratings for simplifications of sentences that originally could have been considered difficult
to understand by non-native speakers of English.
The resulting dataset will be used to develop models and metrics that could potentially produce these scores automatically.
Participants must be:
Over 18 years of age.
Fluent English speakers; both native and non-native speakers are welcome to participate.
We expect to collect at least 10 quality ratings for each sentence pair.
As such, the HITs will be available until that goal is reached.
How will the experiment work?
You are asked to first take a Qualification Test. This will help you get familiar with the rating guidelines and submit suggestions for us. We will manually check your responses to verify that you have understood the task and will award you the Qualification if your ratings are considered suitable. In any case, you will be paid for taking the Qualification Test.
The Qualification Test consists of one pair of sentences: the original and its simplified version. We ask you to rate the quality of the simplification using three criteria: fluency, adequacy and simplicity. More details are provided in the Instructions.
If you pass the Qualification Test, you will be eligible to participate in the Rating Task. The rating guidelines will be the same, but this time you will be asked to rate 10 pairs of sentences
Each HIT should not take more than 10 minutes to complete.
You will be reading sentences extracted from articles in Wikipedia.
The nature of the sentences and their language are such that they are unlikely to cause offence, disturbance or distress to readers from a general audience.
However, if you feel uncomfortable with the content of any of the sentences, please let us know in the Suggestions box provided.
It is important to emphasize that the data collected will be made available for other researchers.
In addition, the results of this investigation may be published in scientific journals or conferences and may be used in further studies.
Finally, if you have any questions do not hesitate to contact Fernando Alva-Manchego (email: f.alva@sheffield.ac.uk).
Preferably, use the official Mechanical Turk mechanisms.
You can also contact Dr. Carolina Scarton (email<EMAIL_ADDRESS>if the task caused you any offence,
disturbance or distress; or you if have further complaints.
Please read the instructions carefully.
Thank you,
Fernando Alva-Manchego, Carolina Scarton, and Lucia Specia
Consent Form
In order to participate in this experiment, you must:
Be at least 18 years old and competent to provide consent.
Have read and understood the the Information Sheet explaining the research project.
Agree for the data collected to be used in anonymised way in the future
Agree to take part in the research previously described.
Suggestions (Optional)
If you have any suggestions regarding the task, please provide them below: