Configuration¶

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 customise Sphinx input and output behaviour.

An optional file docutils.conf can be added to the configuration directory to adjust Docutils configuration if not otherwise overridden or set by Sphinx.

Important points to note:

If not otherwise documented, values must be strings, and their default is the empty string.
The term „fully-qualified name“ (FQN) refers to a string that names an importable Python object inside a module; for example, the fully-qualified name "sphinx.builders.Builder" means the Builder class in the sphinx.builders module.
Document names use / as the path separator and do not contain the file name extension.

Where glob-style patterns are permitted, you can use the standard shell constructs (*, ?, [...], and [!...]) with the feature that none of these will match slashes (/). A double star ** can be used to match any sequence of characters including slashes.

Tipp

The configuration file is executed as Python code at build time (using importlib.import_module(), with the current directory set to the configuration directory), and therefore can execute arbitrarily complex code.

Sphinx then reads simple names from the file’s namespace as its configuration. In general, configuration values should be simple strings, numbers, or lists or dictionaries of simple values.

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 deleting imported modules is not needed.

Project tags¶

There is a special object named tags available in the config file, which exposes the project tags. Tags are defined either via the --tag command-line option or tags.add('tag'). Note that the builder’s name and format tags are not available in conf.py.

It can be used to query and change the defined tags as follows:

To query whether a tag is set, use 'tag' in tags.
To add a tag, use tags.add('tag').
To remove a tag, use tags.remove('tag').

Project information¶

project¶

Type:: str
Default:: 'Project name not set'

The documented project’s name. Example:

project = 'Thermidor'

author¶

Type:: str
Default:: 'Author name not set'

The project’s author(s). Example:

author = 'Joe Bloggs'

copyright¶

project_copyright¶

Type:: str | Sequence[str]
Default:: ''

A copyright statement. Permitted styles are as follows, where ‚YYYY‘ represents a four-digit year.

copyright = 'YYYY'
copyright = 'YYYY, Author Name'
copyright = 'YYYY Author Name'
copyright = 'YYYY-YYYY, Author Name'
copyright = 'YYYY-YYYY Author Name'

If the string '%Y' appears in a copyright line, it will be replaced with the current four-digit year. For example:

copyright = '%Y'
copyright = '%Y, Author Name'
copyright = 'YYYY-%Y, Author Name'

Added in version 3.5: The project_copyright alias.

Geändert in Version 7.1: The value may now be a sequence of copyright statements in the above form, which will be displayed each to their own line.

Geändert in Version 8.1: Copyright statements support the '%Y' placeholder.

version¶

Type:: str
Default:: ''

The major project version, used as the replacement for the |version| default substitution.

This may be something like version = '4.2'. The full project version is defined in release.

If your project does not draw a meaningful distinction between between a ‚full‘ and ‚major‘ version, set both version and release to the same value.

release¶

Type:: str
Default:: ''

The full project version, used as the replacement for the |release| default substitution, and e.g. in the HTML templates.

This may be something like release = '4.2.1b0'. The major (short) project version is defined in version.

If your project does not draw a meaningful distinction between between a ‚full‘ and ‚major‘ version, set both version and release to the same value.

General configuration¶

needs_sphinx¶

Type:: str
Default:: ''

Set a minimum supported version of Sphinx required to build the project. The format should be a 'major.minor' version string like '1.1' Sphinx will compare it with its version and refuse to build the project if the running version of Sphinx is too old. By default, there is no minimum version.

Added in version 1.0.

Geändert in Version 1.4: Allow a 'major.minor.micro' version string.

extensions¶

Type:: list[str]
Default:: []

A list of strings that are module names of Sphinx extensions. These can be extensions bundled with Sphinx (named sphinx.ext.*) or custom first-party or third-party extensions.

To use a third-party extension, you must ensure that it is installed and include it in the extensions list, like so:

extensions = [
    ...
    'numpydoc',
]

There are two options for first-party extensions. The configuration file itself can be an extension; for that, you only need to provide a setup() function in it. Otherwise, you must ensure that your custom extension is importable, and located in a directory that is in the Python path.

Ensure that absolute paths are used when modifying sys.path. If your custom extensions live in a directory that is relative to the configuration directory, use pathlib.Path.resolve() like so:

import sys
from pathlib import Path

sys.path.append(str(Path('sphinxext').resolve()))

extensions = [
   ...
   'extname',
]

The directory structure illustrated above would look like this:

<project directory>/
├── conf.py
└── sphinxext/
    └── extname.py

needs_extensions¶

Type:: dict[str, str]
Default:: {}

If set, this value must be a dictionary specifying version requirements for extensions in extensions. The version strings should be in the 'major.minor' form. Requirements do not have to be specified for all extensions, only for those you want to check. Example:

needs_extensions = {
    'sphinxcontrib.something': '1.5',
}

This requires that the extension declares its version in the setup() function. See Sphinx API for further details.

Added in version 1.3.

manpages_url¶

Type:: str
Default:: ''

A URL to cross-reference manpage roles. If this is defined to https://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.

# To use manpages.debian.org:
manpages_url = 'https://manpages.debian.org/{path}'
# To use man7.org:
manpages_url = 'https://man7.org/linux/man-pages/man{section}/{page}.{section}.html'
# To use linux.die.net:
manpages_url = 'https://linux.die.net/man/{section}/{page}'
# To use helpmanual.io:
manpages_url = 'https://helpmanual.io/man{section}/{page}'

Added in version 1.7.

today¶

today_fmt¶

These values determine how to format the current date, used as the replacement for the |today| default substitution.

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 in today_fmt.

The default for today is '', and the default for today_fmt is '%b %d, %Y' (or, if translation is enabled with language, an equivalent format for the selected locale).

Options for figure numbering¶

numfig¶

Type:: bool
Default:: False

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.

Bemerkung

The LaTeX builder always assigns numbers whether this option is enabled or not.

Added in version 1.3.

numfig_format¶

Type:: dict[str, str]
Default:: {}

A dictionary mapping 'figure', 'table', 'code-block' and 'section' to strings that are used for format of figure numbers. The marker %s will be replaced with the figure number.

The defaults are:

numfig_format = {
    'code-block': 'Listing %s',
    'figure': 'Fig. %s',
    'section': 'Section',
    'table': 'Table %s',
}

Added in version 1.3.

numfig_secnum_depth¶

Type:: int
Default:: 1

If set to 0, figures, tables, and code-blocks are continuously numbered starting at 1.
If 1, the numbering will be x.1, x.2, … with x representing the section number. (If there is no top-level section, the prefix will not be added ). This naturally applies only if section numbering has been activated via the :numbered: option of the toctree directive.
If 2, the numbering will be x.y.1, x.y.2, … with x representing the section number and y the sub-section number. If located directly under a section, there will be no y. prefix, and if there is no top-level section, the prefix will not be added.
Any other positive integer can be used, following the rules above.

Added in version 1.3.

Geändert in Version 1.7: The LaTeX builder obeys this setting if numfig is set to True.

Options for highlighting¶

highlight_language¶

Type:: str
Default:: 'default'

The default language to highlight source code in. The default is 'default', which suppresses warnings if highlighting as Python code fails.

The value should be a valid Pygments lexer name, see Showing code examples for more details.

Added in version 0.5.

Geändert in Version 1.4: The default is now 'default'.

highlight_options¶

Type:: dict[str, dict[str, Any]]
Default:: {}

A dictionary that maps Pygments lexer names to their options. These are lexer-specific; for the options understood by each, see the Pygments documentation.

Example:

highlight_options = {
  'default': {'stripall': True},
  'php': {'startinline': True},
}

Added in version 1.3.

Geändert in Version 3.5: Allow configuring highlight options for multiple lexers.

pygments_style¶

Type:: str
Default:: 'sphinx'

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.

Geändert in Version 0.3: If the value is a fully-qualified name of a custom Pygments style class, this is then used as custom style.

Options for HTTP requests¶

tls_verify¶

Type:: bool
Default:: True

If True, Sphinx verifies server certificates.

Added in version 1.5.

tls_cacerts¶

Type:: str | dict[str, str]
Default:: ''

A path to a certification file of CA or a path to directory which contains the certificates. This also allows a dictionary mapping hostnames to the certificate file path. The certificates are used to verify server certifications.

Added in version 1.5.

Tipp

Sphinx uses requests as a HTTP library internally. If tls_cacerts is not set, Sphinx falls back to requests‘ default behaviour. See SSL Cert Verification for further details.

user_agent¶

Type:: str
Default:: 'Mozilla/5.0 (X11; Linux x86_64; rv:100.0) Gecko/20100101 Firefox/100.0 Sphinx/X.Y.Z'

Set the User-Agent used by Sphinx for HTTP requests.

Added in version 2.3.

Options for internationalisation¶

These options influence Sphinx’s Native Language Support. See the documentation on Internationalization for details.

language¶

Type:: str
Default:: 'en'

The code for the language the documents are written in. Any text automatically generated by Sphinx will be in that language. Also, Sphinx will try to substitute individual paragraphs from your documents with the translation sets obtained from locale_dirs. Sphinx will search language-specific figures named by figure_language_filename (e.g. the German version of myfigure.png will be myfigure.de.png by default setting) and substitute them for original figures. In the LaTeX builder, a suitable language will be selected as an option for the Babel package.

Added in version 0.5.

Geändert in Version 1.4: Support figure substitution

Geändert in Version 5.0: The default is now 'en' (previously None).

Currently supported languages by Sphinx are:

ar – Arabic
bg – Bulgarian
bn – Bengali
ca – Catalan
cak – Kaqchikel
cs – Czech
cy – Welsh
da – Danish
de – German
el – Greek
en – English (default)
eo – Esperanto
es – Spanish
et – Estonian
eu – Basque
fa – Iranian
fi – Finnish
fr – French
he – Hebrew
hi – Hindi
hi_IN – Hindi (India)
hr – Croatian
hu – Hungarian
id – Indonesian
it – Italian
ja – Japanese
ko – Korean
lt – Lithuanian
lv – Latvian
mk – Macedonian
nb_NO – Norwegian Bokmal
ne – Nepali
nl – Dutch
pl – Polish
pt – Portuguese
pt_BR – Brazilian Portuguese
pt_PT – European Portuguese
ro – Romanian
ru – Russian
si – Sinhala
sk – Slovak
sl – Slovenian
sq – Albanian
sr – Serbian
sr@latin – Serbian (Latin)
sr_RS – Serbian (Cyrillic)
sv – Swedish
ta – Tamil
te – Telugu
tr – Turkish
uk_UA – Ukrainian
ur – Urdu
vi – Vietnamese
zh_CN – Simplified Chinese
zh_TW – Traditional Chinese

locale_dirs¶

Type:: list[str]
Default:: ['locales']

Directories in which to search for additional message catalogs (see language), relative to the source directory. The directories on this path are searched by the gettext module.

Internal messages are fetched from a text domain of sphinx; so if you add the directory ./locales to this setting, the message catalogs (compiled from .po format using msgfmt) must be in ./locales/language/LC_MESSAGES/sphinx.mo. The text domain of individual documents depends on gettext_compact.

Bemerkung

The -v option to sphinx-build is useful to check the locale_dirs setting is working as expected. If the message catalog directory not found, debug messages are emitted.

Added in version 0.5.

Geändert in Version 1.5: Use locales directory as a default value

gettext_allow_fuzzy_translations¶

Type:: bool
Default:: False

If True, „fuzzy“ messages in the message catalogs are used for translation.

Added in version 4.3.

gettext_compact¶

Type:: bool | str
Default:: True

If True, a document’s text domain is its docname if it is a top-level project file and its very base directory otherwise.
If False, a document’s text domain is the docname, in full.
If set to a string, every document’s text domain is set to this string, making all documents use single text domain.

With gettext_compact = True, the document markup/code.rst ends up in the markup text domain. With this option set to False, it is markup/code. With this option set to 'sample', it is sample.

Added in version 1.1.

Geändert in Version 3.3: Allow string values.

gettext_uuid¶

Type:: bool
Default:: False

If True, Sphinx generates UUID information for version tracking in message catalogs. It is used to:

Add a UUID line for each msgid in .pot files.
Calculate similarity between new msgids and previously saved old msgids. (This calculation can take a long time.)

Tipp

If you want to accelerate the calculation, you can use a third-party package (Levenshtein) by running pip install levenshtein.

Added in version 1.3.

gettext_location¶

Type:: bool
Default:: True

If True, Sphinx generates location information for messages in message catalogs.

Added in version 1.3.

gettext_auto_build¶

Type:: bool
Default:: True

If True, Sphinx builds a .mo file for each translation catalog file.

Added in version 1.3.

gettext_additional_targets¶

Type:: set[str] | Sequence[str]
Default:: []

Enable gettext translation for certain element types. Example:

gettext_additional_targets = {'literal-block', 'image'}

The following element types are supported:

'index' – index terms
'literal-block' – literal blocks (:: annotation and code-block directive)
'doctest-block' – doctest block
'raw' – raw content
'image' – image/figure uri

Added in version 1.3.

Geändert in Version 4.0: The alt text for images is translated by default.

Geändert in Version 7.4: Permit and prefer a set type.

figure_language_filename¶

Type:: str
Default:: '{root}.{language}{ext}'

The filename format for language-specific figures. The available format tokens are:

{root}: the filename, including any path component, without the file extension. For example: images/filename.
{path}: the directory path component of the filename, with a trailing slash if non-empty. For example: images/.
{basename}: the filename without the directory path or file extension components. For example: filename.
{ext}: the file extension. For example: .png.
{language}: the translation language. For example: en.
{docpath}: the directory path component for the current document, with a trailing slash if non-empty. For example: dirname/.

By default, an image directive .. image:: images/filename.png, using an image at images/filename.png, will use the language-specific figure filename images/filename.en.png.

If figure_language_filename is set as below, the language-specific figure filename will be images/en/filename.png instead.

figure_language_filename = '{path}{language}/{basename}{ext}'

Added in version 1.4.

Geändert in Version 1.5: Added {path} and {basename} tokens.

Geändert in Version 3.2: Added {docpath} token.

translation_progress_classes¶

Type:: bool | 'translated' | 'untranslated'
Default:: False

Control which, if any, classes are added to indicate translation progress. This setting would likely only be used by translators of documentation, in order to quickly indicate translated and untranslated content.

True: Add translated and untranslated classes to all nodes with translatable content.
'translated': Only add the translated class.
'untranslated': Only add the untranslated class.
False: Do not add any classes to indicate translation progress.

Added in version 7.1.

Options for markup¶

default_role¶

Type:: str
Default:: None

The name of a reStructuredText 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 role can always be set within individual documents using the standard reStructuredText default-role directive.

Added in version 0.4.

keep_warnings¶

Type:: bool
Default:: False

Keep warnings as „system message“ paragraphs in the rendered documents. Warnings are always written to the standard error stream when sphinx-build is run, regardless of this setting.

Added in version 0.5.

option_emphasise_placeholders¶

Type:: bool
Default:: False

When enabled, emphasise placeholders in option directives. To display literal braces, escape with a backslash (\{). For example, option_emphasise_placeholders=True and .. option:: -foption={TYPE} would render with TYPE emphasised.

Added in version 5.1.

primary_domain¶

Type:: str
Default:: 'py'

The name of the default domain. Can also be None to disable a default domain. The default is 'py', for the Python domain.

Those objects in other domain (whether the domain name is given explicitly, or selected by a default-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“). Example:

primary_domain = 'cpp'

Added in version 1.0.

rst_epilog¶

Type:: str
Default:: ''

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). Example:

rst_epilog = """
.. |psf| replace:: Python Software Foundation
"""

Added in version 0.6.

rst_prolog¶

Type:: str
Default:: ''

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). Example:

rst_prolog = """
.. |psf| replace:: Python Software Foundation
"""

Added in version 1.0.

show_authors¶

Type:: bool
Default:: False

A boolean that decides whether codeauthor and sectionauthor directives produce any output in the built files.

trim_footnote_reference_space¶

Type:: bool
Default:: False

Trim spaces before footnote references that are necessary for the reStructuredText parser to recognise the footnote, but do not look too nice in the output.

Added in version 0.6.

Options for Maths¶

These options control maths markup and notation.

math_eqref_format¶

Type:: str
Default:: '({number})'

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.

Added in version 1.7.

math_number_all¶

Type:: bool
Default:: False

Force all displayed equations to be numbered. Example:

math_number_all = True

Added in version 1.4.

math_numfig¶

Type:: bool
Default:: True

If True, displayed math equations are numbered across pages when numfig is enabled. The numfig_secnum_depth setting is respected. The eq, not numref, role must be used to reference equation numbers.

Added in version 1.7.

math_numsep¶

Type:: str
Default:: '.'

A string that defines the separator between section numbers and the equation number when numfig is enabled and numfig_secnum_depth is positive.

Example: '-' gets rendered as 1.2-3.

Added in version 7.4.

Options for the nitpicky mode¶

nitpicky¶

Type:: bool
Default:: False

Enables nitpicky mode if True. In nitpicky mode, Sphinx will warn about all references where the target cannot be found. This is recommended for new projects as it ensures that all references are to valid targets.

You can activate this mode temporarily using the --nitpicky command-line option. See nitpick_ignore for a way to mark missing references as „known missing“.

nitpicky = True

Added in version 1.0.

nitpick_ignore¶

Type:: set[tuple[str, str]] | Sequence[tuple[str, str]]
Default:: ()

A set or list of (warning_type, target) tuples that should be ignored when generating warnings in "nitpicky mode". Note that warning_type should include the domain name if present. Example:

nitpick_ignore = {
    ('py:func', 'int'),
    ('envvar', 'LD_LIBRARY_PATH'),
}

Added in version 1.1.

Geändert in Version 6.2: Changed allowable container types to a set, list, or tuple

nitpick_ignore_regex¶

Type:: set[tuple[str, str]] | Sequence[tuple[str, str]]
Default:: ()

An extended version of nitpick_ignore, which instead interprets the warning_type and target strings as regular expressions. Note that the regular expression must match the whole string (as if the ^ and $ markers were inserted).

For example, (r'py:.*', r'foo.*bar\.B.*') will ignore nitpicky warnings for all python entities that start with 'foo' and have 'bar.B' in them, such as ('py:const', 'foo_package.bar.BAZ_VALUE') or ('py:class', 'food.bar.Barman').

Added in version 4.1.

Geändert in Version 6.2: Changed allowable container types to a set, list, or tuple

Options for object signatures¶

add_function_parentheses¶

Type:: bool
Default:: True

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.

maximum_signature_line_length¶

Type:: int | None
Default:: None

If a signature’s length in characters exceeds the number set, each parameter within the signature will be displayed on an individual logical line.

When None, there is no maximum length and the entire signature will be displayed on a single logical line.

A ‚logical line‘ is similar to a hard line break—builders or themes may choose to ‚soft wrap‘ a single logical line, and this setting does not affect that behaviour.

Domains may provide options to suppress any hard wrapping on an individual object directive, such as seen in the C, C++, and Python domains (e.g. py:function:single-line-parameter-list).

Added in version 7.1.

strip_signature_backslash¶

Type:: bool
Default:: False

When backslash stripping is enabled then every occurrence of \\ in a domain directive will be changed to \, even within string literals. This was the behaviour before version 3.0, and setting this variable to True will reinstate that behaviour.

Added in version 3.0.

toc_object_entries¶

Type:: bool
Default:: True

Create table of contents entries for domain objects (e.g. functions, classes, attributes, etc.).

Added in version 5.2.

toc_object_entries_show_parents¶

Type:: 'domain' | 'hide' | 'all'
Default:: 'domain'

A string that determines how domain objects (functions, classes, attributes, etc.) are displayed in their table of contents entry.

Use 'domain' to allow the domain to determine the appropriate number of parents to show. For example, the Python domain would show Class.method() and function(), leaving out the module. level of parents.

Use 'hide' to only show the name of the element without any parents (i.e. method()).

Use 'all' to show the fully-qualified name for the object (i.e. module.Class.method()), displaying all parents.

Added in version 5.2.

Options for source files¶

exclude_patterns¶

Type:: Sequence[str]
Default:: ()

A list of glob-style patterns that should be excluded when looking for source files. They are matched against the source file names relative to the source directory, using slashes as directory separators on all platforms. exclude_patterns has priority over include_patterns.

Example patterns:

'library/xml.rst' – ignores the library/xml.rst file
'library/xml' – ignores the library/xml directory
'library/xml*' – ignores all files and directories starting with library/xml
'**/.git' – ignores all .git directories
'Thumbs.db' – ignores all Thumbs.db files

exclude_patterns is also consulted when looking for static files in html_static_path and html_extra_path.

Added in version 1.0.

include_patterns¶

Type:: Sequence[str]
Default:: ('**',)

A list of glob-style patterns that are used to find source files. They are matched against the source file names relative to the source directory, using slashes as directory separators on all platforms. By default, all files are recursively included from the source directory. exclude_patterns has priority over include_patterns.

Example patterns:

'**' – all files in the source directory and subdirectories, recursively
'library/xml' – just the library/xml directory
'library/xml*' – all files and directories starting with library/xml
'**/doc' – all doc directories (this might be useful if documentation is co-located with source files)

Added in version 5.1.

master_doc¶

root_doc¶

Type:: str
Default:: 'index'

Sphinx builds a tree of documents based on the toctree directives contained within the source files. This sets the name of the document containing the master toctree directive, and hence the root of the entire tree. Example:

master_doc = 'contents'

Geändert in Version 2.0: Default is 'index' (previously 'contents').

Added in version 4.0: The root_doc alias.

source_encoding¶

Type:: str
Default:: 'utf-8-sig'

The file encoding of all source files. The recommended encoding is 'utf-8-sig'.

Added in version 0.5.

source_suffix¶

Type:: dict[str, str] | Sequence[str] | str
Default:: {'.rst': 'restructuredtext'}

A dictionary mapping the file extensions (suffixes) of source files to their file types. Sphinx considers all files files with suffixes in source_suffix to be source files. Example:

source_suffix = {
    '.rst': 'restructuredtext',
    '.txt': 'restructuredtext',
    '.md': 'markdown',
}

By default, Sphinx only supports the 'restructuredtext' file type. Further file types can be added with extensions that register different source file parsers, such as MyST-Parser. Refer to the extension’s documentation to see which file types it supports.

If the value is a string or sequence of strings, Sphinx will consider that they are all 'restructuredtext' files.

Bemerkung

File extensions must begin with a dot ('.').

Geändert in Version 1.3: Support a list of file extensions.

Geändert in Version 1.8: Change to a map of file extensions to file types.

Options for smart quotes¶

smartquotes¶

Type:: bool
Default:: True

If True, the Smart Quotes transform will be used to convert quotation marks and dashes to typographically correct entities.

Added in version 1.6.6: Replaces the now-removed html_use_smartypants. It applies by default to all builders except man and text (see smartquotes_excludes.)

Bemerkung

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, then smartquotes does prevail.

smartquotes_action¶

Type:: str
Default:: 'qDe'

Customise the Smart Quotes transform. See below for the permitted codes. The default 'qDe' educates normal quote characters ", ', em- and en-Dashes ---, --, and ellipses .....

'q': Convert quotation marks
'b': Convert backtick quotation marks (``double'' only)
'B': Convert backtick quotation marks (``double'' and `single')
'd': Convert dashes (convert -- to em-dashes and --- to en-dashes)
'D': Convert dashes (old school) (convert -- to en-dashes and --- to em-dashes)
'i': Convert dashes (inverted old school) (convert -- to em-dashes and --- to en-dashes)
'e': Convert ellipses ...
'w': Convert '"' entities to '"'

Added in version 1.6.6.

smartquotes_excludes¶

Type:: dict[str, list[str]]
Default:: {'languages': ['ja'], 'builders': ['man', 'text']}

Control when the Smart Quotes transform is disabled. Permitted keys are 'builders' and 'languages', and The values are lists of strings.

Each entry gives a sufficient condition to ignore the smartquotes setting and deactivate the Smart Quotes transform. Example:

smartquotes_excludes = {
    'languages': ['ja'],
    'builders': ['man', 'text'],
}

Bemerkung

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, a make text following make html needs to be issued in the form make text SPHINXOPTS="-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.

Hinweis

An alternative way to effectively deactivate (or customise) the smart quotes for a given builder, for example latex, is to use make this way:

make latex SPHINXOPTS="-D smartquotes_action="

This can follow some make html with no problem, in contrast to the situation from the prior note.

Added in version 1.6.6.

Options for templating¶

template_bridge¶

Type:: str
Default:: ''

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.) Example:

template_bridge = 'module.CustomTemplateBridge'

templates_path¶

Type:: Sequence[str]
Default:: ()

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. Example:

templates_path = ['.templates']

Geändert in Version 1.3: As these files are not meant to be built, they are automatically excluded when discovering source files.

Options for warning control¶

show_warning_types¶

Type:: bool
Default:: True

Add the type of each warning as a suffix to the warning message. For example, WARNING: [...] [index] or WARNING: [...] [toc.circular]. This setting can be useful for determining which warnings types to include in a suppress_warnings list.

Added in version 7.3.0.

Geändert in Version 8.0.0: The default is now True.

suppress_warnings¶

Type:: Sequence[str]
Default:: ()

A list of warning codes to suppress arbitrary warning messages.

By default, Sphinx supports the following warning codes:

app.add_node
app.add_directive
app.add_role
app.add_generic_role
app.add_source_parser
config.cache
docutils
download.not_readable
epub.unknown_project_files
epub.duplicated_toc_entry
i18n.inconsistent_references
index
image.not_readable
ref.term
ref.ref
ref.numref
ref.keyword
ref.option
ref.citation
ref.footnote
ref.doc
ref.python
misc.copy_overwrite
misc.highlighting_failure
toc.circular
toc.excluded
toc.no_title
toc.not_readable
toc.secnum

Extensions can also define their own warning types. Those defined by the first-party sphinx.ext extensions are:

autodoc
autodoc.import_object
autosectionlabel.<document name>
autosummary
autosummary.import_cycle
intersphinx.external

You can choose from these types. You can also give only the first component to exclude all warnings attached to it.

Added in version 1.4.

Geändert in Version 1.5: Added misc.highlighting_failure

Geändert in Version 1.5.1: Added epub.unknown_project_files

Geändert in Version 1.6: Added ref.footnote

Geändert in Version 2.1: Added autosectionlabel.<document name>

Geändert in Version 3.3.0: Added epub.duplicated_toc_entry

Geändert in Version 4.3: Added toc.excluded and toc.not_readable

Added in version 4.5: Added i18n.inconsistent_references

Added in version 7.1: Added index.

Added in version 7.3: Added config.cache.

Added in version 7.3: Added toc.no_title.

Added in version 8.0: Added misc.copy_overwrite.

Builder options¶

Options for HTML output¶

These options influence HTML output. Various other builders are derived from the HTML output, and also make use of these options.

html_theme¶

Type:: str
Default:: 'alabaster'

The theme for HTML output. See the HTML theming section.

Added in version 0.6.

Geändert in Version 1.3: The default theme is now 'alabaster'.

html_theme_options¶

Type:: dict[str, Any]
Default:: {}

A dictionary of options that influence the look and feel of the selected theme. These are theme-specific. The options understood by the builtin themes are described here.

Added in version 0.6.

html_theme_path¶

Type:: list[str]
Default:: []

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.

Added in version 0.6.

html_style¶

Type:: Sequence[str] | str
Default:: ()

Stylesheets to use for HTML pages. The stylesheet given by the selected theme is used by default A file of that name must exist either in Sphinx’s static/ path or in one of the custom paths given in html_static_path. If you only want to add or override a few things from the theme, use CSS @import to import the theme’s stylesheet.

Geändert in Version 5.1: The value can be a iterable of strings.

html_title¶

Type:: str
Default:: 'project release documentation'

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.

html_short_title¶

Type:: str
Default:: The value of html_title

A shorter „title“ for HTML documentation. This is used for links in the header and in the HTML Help documentation.

Added in version 0.4.

html_baseurl¶

Type:: str
Default:: ''

The base URL which points to the root of the HTML documentation. It is used to indicate the location of document using the Canonical Link Relation.

Added in version 1.8.

html_codeblock_linenos_style¶

Type:: 'inline' | 'table'
Default:: 'inline'

The style of line numbers for code-blocks.

'table': Display line numbers using <table> tag
'inline': Display line numbers using <span> tag

Added in version 3.2.

Geändert in Version 4.0: It defaults to 'inline'.

Veraltet ab Version 4.0.

html_context¶

Type:: dict[str, Any]
Default:: {}

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 sphinx-build’s --html-define command-line option.

Added in version 0.5.

html_logo¶

Type:: str
Default:: ''

If given, this must be the name of an image file (path relative to the configuration directory) that is the logo of the documentation, or a URL that points an image file for the logo. It is placed at the top of the sidebar; its width should therefore not exceed 200 pixels.

Added in version 0.4.1: The image file will be copied to the _static directory, but only if the file does not already exist there.

Geändert in Version 4.0: Also accepts a URL.

html_favicon¶

Type:: str
Default:: ''

If given, this must be the name of an image file (path relative to the configuration directory) that is the favicon of the documentation, or a URL that points an image file for the favicon. Browsers use this as the icon for tabs, windows and bookmarks. It should be a 16-by-16 pixel icon in the PNG, SVG, GIF, or ICO file formats.

Example:

html_favicon = 'static/favicon.png'

Added in version 0.4: The image file will be copied to the _static, but only if the file does not already exist there.

Geändert in Version 4.0: Also accepts the URL for the favicon.

html_css_files¶

Type:: Sequence[str | tuple[str, dict[str, str]]]
Default:: []

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 like 'https://example.org/style.css'. The attributes dictionary is used for the <link> tag’s attributes.

Example:

html_css_files = [
    'custom.css',
    'https://example.com/css/custom.css',
    ('print.css', {'media': 'print'}),
]

The special attribute priority can be set as an integer to load the CSS file at an earlier or later step. For more information, refer to Sphinx.add_css_file().

Added in version 1.8.

Geändert in Version 3.5: Support the priority attribute

html_js_files¶

Type:: Sequence[str | tuple[str, dict[str, str]]]
Default:: []

A list of JavaScript 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 like 'https://example.org/script.js'. The attributes dictionary is used for the <script> tag’s attributes.

Example:

html_js_files = [
    'script.js',
    'https://example.com/scripts/custom.js',
    ('custom.js', {'async': 'async'}),
]

As a special attribute, priority can be set as an integer to load the JavaScript file at an earlier or later step. For more information, refer to Sphinx.add_js_file().

Added in version 1.8.

Geändert in Version 3.5: Support the priority attribute

html_static_path¶

Type:: list[str]
Default:: []

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 named default.css will overwrite the theme’s default.css.

As these files are not meant to be built, they are automatically excluded from source files.

Bemerkung

For security reasons, dotfiles under html_static_path will not be copied. If you would like to copy them intentionally, explicitly add each file to this setting:

html_static_path = ['_static', '_static/.htaccess']

An alternative approach is to use html_extra_path, which allows copying dotfiles under the directories.

Geändert in Version 0.4: The paths in html_static_path can now contain subdirectories.

Geändert in Version 1.0: The entries in html_static_path can now be single files.

Geändert in Version 1.8: The files under html_static_path are excluded from source files.

html_extra_path¶

Type:: list[str]
Default:: []

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.

Added in version 1.2.

Geändert in Version 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¶

Type:: str
Default:: None

If set, a ‚Last updated on:‘ timestamp is inserted into the page footer using the given strftime() format. The empty string is equivalent to '%b %d, %Y' (or a locale-dependent equivalent).

html_last_updated_use_utc¶

Type:: bool
Default:: False

Use GMT/UTC (+00:00) instead of the system’s local time zone for the time supplied to html_last_updated_fmt. This is most useful when the format used includes the time.

html_permalinks¶

Type:: bool
Default:: True

Add link anchors for each heading and description environment.

Added in version 3.5.

html_permalinks_icon¶

Type:: str
Default:: '¶' (the paragraph sign)

Text for link anchors for each heading and description environment. HTML entities and Unicode are allowed.

Added in version 3.5.

html_sidebars¶

Type:: dict[str, Sequence[str]]
Default:: {}

A dictionary defining custom sidebar templates, mapping document names to template names.

The keys can contain glob-style patterns, 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.)

Each value must be a list of strings which 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. The builtin themes use these templates by default: 'localtoc.html', 'relations.html', 'sourcelink.html', and 'searchbox.html'.

The bundled first-party 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': ['windows-sidebar.html', 'searchbox.html'],
}

This will render the custom template windows-sidebar.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).

Note that this value only has no effect if the chosen theme does not possess a sidebar, like the builtin scrolls and haiku themes.

Added in version 1.0: The ability to use globbing keys and to specify multiple sidebars.

Veraltet ab Version 1.7: A single string value for html_sidebars will be removed.

Geändert in Version 2.0: html_sidebars must be a list of strings, and no longer accepts a single string value.

html_additional_pages¶

Type:: dict[str, str]
Default:: {}

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': 'custom-download.html.jinja',
}

This will render the template custom-download.html.jinja as the page download.html.

html_domain_indices¶

Type:: bool | Sequence[str]
Default:: True

If True, generate domain-specific indices in addition to the general index. For e.g. the Python domain, this is the global module index.

This value can be a Boolean 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'.

Example:

html_domain_indices = {
    'py-modindex',
}

Added in version 1.0.

Geändert in Version 7.4: Permit and prefer a set type.

html_use_index¶

Type:: bool
Default:: True

Controls if an index is added to the HTML documents.

Added in version 0.4.

html_split_index¶

Type:: bool
Default:: False

Generates two versions of the index: once as a single page with all the entries, and once as one page per starting letter.

Added in version 0.4.

html_copy_source¶

Type:: bool
Default:: True

If True, the reStructuredText sources are included in the HTML build as _sources/docname.

html_show_sourcelink¶

Type:: bool
Default:: True

If True (and html_copy_source is true as well), links to the reStructuredText sources will be added to the sidebar.

Added in version 0.6.

html_sourcelink_suffix¶

Type:: str
Default:: '.txt'

The suffix to append to source links (see html_show_sourcelink), unless files they have this suffix already.

Added in version 1.5.

html_use_opensearch¶

Type:: str
Default:: ''

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'.

Added in version 0.2.

html_file_suffix¶

Type:: str
Default:: '.html'

The file name suffix (file extension) for generated HTML files.

Added in version 0.4.

html_link_suffix¶

Type:: str
Default:: The value of html_file_suffix

The suffix for generated links to HTML files. Intended to support more esoteric server setups.

Added in version 0.6.

html_show_copyright¶

Type:: bool
Default:: True

If True, „© Copyright …“ is shown in the HTML footer, with the value or values from copyright.

Added in version 1.0.

html_show_search_summary¶

Type:: bool
Default:: True

Show a summary of the search result, i.e., the text around the keyword.

Added in version 4.5.

html_show_sphinx¶

Type:: bool
Default:: True

Add „Created using Sphinx“ to the HTML footer.

Added in version 0.4.

html_output_encoding¶

Type:: str
Default:: 'utf-8'

Encoding of HTML output files. This encoding name must both be a valid Python encoding name and a valid HTML charset value.

Added in version 1.0.

html_compact_lists¶

Type:: bool
Default:: True

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 behaviour. Default: True.

Added in version 1.0.

html_secnumber_suffix¶

Type:: str
Default:: '. '

Suffix for section numbers in HTML output. Set to ' ' to suppress the final dot on section numbers.

Added in version 1.0.

html_search_language¶

Type:: str
Default:: The value of language

Language to be used for generating the HTML full-text search index. This defaults to the global language selected with language. English ('en') is used as a fall-back option if there is no support for this language.

Support exists for the following languages:

da – Danish
nl – Dutch
en – English
fi – Finnish
fr – French
de – German
hu – Hungarian
it – Italian
ja – Japanese
no – Norwegian
pt – Portuguese
ro – Romanian
ru – Russian
es – Spanish
sv – Swedish
tr – Turkish
zh – Chinese

Tipp

Accelerating build speed

Each language (except Japanese) provides its own stemming algorithm. Sphinx uses a Python implementation by default. If you want to accelerate building the index file, you can use a third-party package (PyStemmer) by running pip install PyStemmer.

Added in version 1.1: Support English (en) and Japanese (ja).

Geändert in Version 1.3: Added additional languages.

html_search_options¶

Type:: dict[str, str]
Default:: {}

A dictionary with options for the search language support. The meaning of these options depends on the language selected. Currently, only Japanese and Chinese support options.

Japanese:

type – the type of the splitter to use.

The other options depend on the splitter used.

'sphinx.search.ja.DefaultSplitter': The TinySegmenter algorithm, used by default.
'sphinx.search.ja.MecabSplitter':: The MeCab binding To use this splitter, the ‚mecab‘ python binding or dynamic link library (‚libmecab.so‘ for Linux, ‚libmecab.dll‘ for Windows) is required.
'sphinx.search.ja.JanomeSplitter':: The Janome binding. To use this splitter, Janome is required.

Veraltet ab Version 1.6: 'mecab', 'janome' and 'default' is deprecated. To keep compatibility, 'mecab', 'janome' and 'default' are also acceptable.

Options for '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.

For example:

html_search_options = {
    'type': 'mecab',
    'dic_enc': 'utf-8',
    'dict': '/path/to/mecab .dic',
    'lib': '/path/to/libmecab.so',
}

Options for '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‘.

Chinese:

dict: The jieba dictionary path for using a custom dictionary.

Added in version 1.1.

Geändert in Version 1.4: Allow any custom splitter in the type setting for Japanese.

html_search_scorer¶

Type:: str
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.

The scorer must implement the following interface, and may optionally define the score() function for more granular control.

const Scorer = {
    // Implement the following function to further tweak the score for each result
    score: result => {
      const [docName, title, anchor, descr, score, filename] = result

      // ... calculate a new score ...
      return score
    },

    // query matches the full name of an object
    objNameMatch: 11,
    // or matches in the last dotted part of the object name
    objPartialMatch: 6,
    // Additive scores depending on the priority of the object
    objPrio: {
      0: 15, // used to be importantResults
      1: 5, // used to be objectResults
      2: -5, // used to be unimportantResults
    },
    //  Used when the priority is not in the mapping.
    objPrioDefault: 0,

    // query found in title
    title: 15,
    partialTitle: 7,

    // query found in terms
    term: 5,
    partialTerm: 2,
};

Added in version 1.2.

html_scaled_image_link¶

Type:: bool
Default:: True

Link images that have been resized with a scale option (scale, width, or height) to their original full-resolution image. This will not overwrite any link given by the target option on the the image directive, if present.

Tipp

To disable this feature on a per-image basis, add the no-scaled-link class to the image directive:

.. image:: sphinx.png
   :scale: 50%
   :class: no-scaled-link

Added in version 1.3.

Geändert in Version 3.0: Images with the no-scaled-link class will not be linked.

html_math_renderer¶

Type:: str
Default:: 'mathjax'

The maths renderer to use for HTML output. The bundled renders are mathjax and imgmath. You must also load the relevant extension in extensions.

Added in version 1.8.

Options for Single HTML output¶

These options influence Single HTML output. This builder derives from the HTML builder, so the HTML options also apply where appropriate.

singlehtml_sidebars¶

Type:: dict[str, Sequence[str]]
Default:: The value of html_sidebars

A dictionary defining custom sidebar templates, mapping document names to template names.

This has the same effect as html_sidebars, but the only permitted key is 'index', and all other keys are ignored.

Options for HTML help output¶

These options influence HTML help output. This builder derives from the HTML builder, so the HTML options also apply where appropriate.

htmlhelp_basename¶

Type:: str
Default:: '{project}doc'

Output file base name for HTML help builder. The default is the project name with spaces removed and doc appended.

htmlhelp_file_suffix¶

Type:: str
Default:: '.html'

This is the file name suffix for generated HTML help files.

Added in version 2.0.

htmlhelp_link_suffix¶

Type:: str
Default:: The value of htmlhelp_file_suffix

Suffix for generated links to HTML files.

Added in version 2.0.

Options for Apple Help output¶

Added in version 1.3.

These options influence Apple Help output. This builder derives from the HTML builder, so the HTML options also apply where appropriate.

Bemerkung

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 directories within the bundle.

applehelp_bundle_name¶

Type:: str
Default:: The value of project

The basename for the Apple Help Book. The default is the project name with spaces removed.

applehelp_bundle_id¶

Type:: str
Default:: None

The bundle ID for the help book bundle.

Warnung

You must set this value in order to generate Apple Help.

applehelp_bundle_version¶

Type:: str
Default:: '1'

The bundle version, as a string.

applehelp_dev_region¶

Type:: str
Default:: 'en-us'

The development region. Defaults to Apple’s recommended setting, 'en-us'.

applehelp_icon¶

Type:: str
Default:: None

Path to 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¶

Type:: str
Default:: 'project-release'

The product tag for use with applehelp_kb_url.

applehelp_kb_url¶

Type:: str
Default:: None

The URL for your knowledgebase server, e.g. https://example.com/kbsearch.py?p='product'&q='query'&l='lang'. At runtime, Help Viewer will replace 'product' with the contents of applehelp_kb_product, 'query' with the text entered by the user in the search box, and 'lang' with the user’s system language.

Set this to to None to disable remote search.

applehelp_remote_url¶

Type:: str
Default:: None

The URL for remote content. You can place a copy of your Help Book’s Resources directory at this location and Help Viewer will attempt to use it to fetch updated content.

For example, if you set it to https://example.com/help/Foo/ and Help Viewer wants a copy of index.html for an English speaking customer, it will look at https://example.com/help/Foo/en.lproj/index.html.

Set this to to None for no remote content.

applehelp_index_anchors¶

Type:: bool
Default:: False

Tell the help indexer to index anchors in the generated HTML. This can be useful for jumping to a particular topic using the AHLookupAnchor function or the openHelpAnchor:inBook: method in your code. It also allows you to use help:anchor URLs; see the Apple documentation for more information on this topic.

applehelp_min_term_length¶

Type:: str
Default:: None

Controls the minimum term length for the help indexer. If None, use the default length.

applehelp_stopwords¶

Type:: str
Default:: The value of language

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:

German (de)
English (en)
Spanish (es)
French (fr)
Hungarian (hu)
Italian (it)
Swedish (sv)

applehelp_locale¶

Type:: str
Default:: The value of language

Specifies the locale to generate help for. This is used to determine the name of the .lproj directory inside the Help Book’s Resources, and is passed to the help indexer.

applehelp_title¶

Type:: str
Default:: 'project Help'

Specifies the help book title.

applehelp_codesign_identity¶

Type:: str
Default:: The value of CODE_SIGN_IDENTITY

Specifies the identity to use for code signing. Use None if code signing is not to be performed.

Defaults to the value of the CODE_SIGN_IDENTITY environment variable, which is set by Xcode for script build phases, or None if that variable is not set.

applehelp_codesign_flags¶

Type:: list[str]
Default:: The value of OTHER_CODE_SIGN_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 OTHER_CODE_SIGN_FLAGS environment variable, which is set by Xcode for script build phases, or the empty list if that variable is not set.

applehelp_codesign_path¶

Type:: str
Default:: '/usr/bin/codesign'

The path to the codesign program.

applehelp_indexer_path¶

Type:: str
Default:: '/usr/bin/hiutil'

The path to the hiutil program.

applehelp_disable_external_tools¶

Type:: bool
Default:: False

Do 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-macOS platform and then complete the final steps on a Mac for some reason.

Options for EPUB output¶

These options influence EPUB output. This builder derives from the HTML builder, so the HTML options also apply where appropriate.

Bemerkung

The actual value for some of these options is not important, but they are required for the Dublin Core metadata.

epub_basename¶

Type:: str
Default:: The value of project

The basename for the EPUB file.

epub_theme¶

Type:: str
Default:: 'epub'

The HTML theme for the EPUB output. Since the default themes are not optimised 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¶

Type:: dict[str, Any]
Default:: {}

A dictionary of options that influence the look and feel of the selected theme. These are theme-specific. The options understood by the builtin themes are described here.

Added in version 1.2.

epub_title¶

Type:: str
Default:: The value of project

The title of the document.

Geändert in Version 2.0: It defaults to the project option (previously html_title).

epub_description¶

Type:: str
Default:: 'unknown'

The description of the document.

Added in version 1.4.

Geändert in Version 1.5: Renamed from epub3_description

epub_author¶

Type:: str
Default:: The value of author

The author of the document. This is put in the Dublin Core metadata.

epub_contributor¶

Type:: str
Default:: 'unknown'

The name of a person, organisation, etc. that played a secondary role in the creation of the content of an EPUB Publication.

Added in version 1.4.

Geändert in Version 1.5: Renamed from epub3_contributor

epub_language¶

Type:: str
Default:: The value of language

The language of the document. This is put in the Dublin Core metadata.

epub_publisher¶

Type:: str
Default:: The value of author

The publisher of the document. This is put in the Dublin Core metadata. You may use any sensible string, e.g. the project homepage.

epub_copyright¶

Type:: str
Default:: The value of copyright

The copyright of the document. See copyright for permitted formats.

epub_identifier¶

Type:: str
Default:: 'unknown'

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.

epub_scheme¶

Type:: str
Default:: 'unknown'

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.

epub_uid¶

Type:: str
Default:: 'unknown'

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.

epub_cover¶

Type:: tuple[str, str]
Default:: ()

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 = ()

Added in version 1.1.

epub_css_files¶

Type:: Sequence[str | tuple[str, dict[str, str]]]
Default:: []

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 like 'https://example.org/style.css'. The attributes dictionary is used for the <link> tag’s attributes. For more information, see html_css_files.

Added in version 1.8.

epub_guide¶

Type:: Sequence[tuple[str, str, str]]
Default:: ()

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 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', 'Cover Page'),
)

The default value is ().

epub_pre_files¶

Type:: Sequence[tuple[str, str]]
Default:: ()

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'),
]

epub_post_files¶

Type:: Sequence[tuple[str, str]]
Default:: ()

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.

Example:

epub_post_files = [
    ('appendix.xhtml', 'Appendix'),
]

epub_exclude_files¶

Type:: Sequence[str]
Default:: []

A sequence of files that are generated/copied in the build directory but should not be included in the EPUB file.

epub_tocdepth¶

Type:: int
Default:: 3

The depth of the table of contents in the file toc.ncx. It should be an integer greater than zero.

Tipp

A deeply nested table of contents may be difficult to navigate.

epub_tocdup¶

Type:: bool
Default:: True

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.

epub_tocscope¶

Type:: 'default' | 'includehidden'
Default:: 'default'

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
'includehidden': Include all ToC entries

Added in version 1.2.

epub_fix_images¶

Type:: bool
Default:: False

Try and fix image formats that are not supported by some EPUB readers. At the moment palette images with a small colour table are upgraded. This is disabled by default because the automatic conversion may lose information. You need the Python Image Library (Pillow) installed to use this option.

Added in version 1.2.

epub_max_image_width¶

Type:: int
Default:: 0

This option specifies the maximum width of images. If it is set to a valuevgreater than zero, images with a width larger than the given value are scaled accordingly. If it is zero, no scaling is performed. You need the Python Image Library (Pillow) installed to use this option.

Added in version 1.2.

epub_show_urls¶

Type:: 'footnote' | 'no' | 'inline'
Default:: 'footnote'

Control how to display URL addresses. This is very useful for readers that have no other means to display the linked URL. The setting can have the following values:

'inline': Display URLs inline in parentheses.
'footnote': Display URLs in footnotes.
'no': Do not display URLs.

The display of inline URLs can be customised by adding CSS rules for the class link-target.

Added in version 1.2.

epub_use_index¶

Type:: bool
Default:: The value of html_use_index

Add an index to the EPUB document.

Added in version 1.2.

epub_writing_mode¶

Type:: 'horizontal' | 'vertical'
Default:: 'horizontal'

It specifies writing direction. It can accept 'horizontal' and 'vertical'

`epub_writing_mode`	`'horizontal'`	`'vertical'`
writing-mode	`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.

Options for LaTeX output¶

These options influence LaTeX output.

latex_engine¶

Type:: 'pdflatex' | 'xelatex' | 'lualatex' | 'platex' | 'uplatex'
Default:: 'pdflatex'

The LaTeX engine to build the documentation. The setting can have the following values:

'pdflatex' – PDFLaTeX (default)
'xelatex' – XeLaTeX (default if language is one of el, zh_CN, or zh_TW)
'lualatex' – LuaLaTeX
'platex' – pLaTeX
'uplatex' – upLaTeX (default if language is 'ja')

Wichtig

'pdflatex'‚s support for Unicode characters is limited. 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 typeface is GNU FreeFont, which has good coverage of Latin, Cyrillic, and Greek glyphs.

Bemerkung

Sphinx 2.0 adds support for occasional Cyrillic and Greek letters or words in documents using a Latin language and 'pdflatex'. To enable this, the 'fontenc' key of latex_elements must be used appropriately.

Bemerkung

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 add r'\usepackage{unicode-math}' (e.g. via the 'preamble' key of latex_elements). You may prefer r'\usepackage[math-style=literal]{unicode-math}' to keep a Unicode literal such as α (U+03B1) as-is in output, rather than being rendered as $\alpha$.

Geändert in Version 2.1.0: Use 'xelatex' (and LaTeX package xeCJK) by default for Chinese documents.

Geändert in Version 2.2.1: Use 'xelatex' by default for Greek documents.

Geändert in Version 2.3: Add 'uplatex' support.

Geändert in Version 4.0: Use 'uplatex' by default for Japanese documents.

latex_documents¶

Type:: Sequence[tuple[str, str, str, str, str, bool]]
Default:: The default 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, theme, 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).
theme: LaTeX theme. See latex_theme.
toctree_only: Must be True or False. 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.

Added in version 0.3: The 6th item toctree_only. Tuples with 5 items are still accepted.

Added in version 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.

latex_logo¶

Type:: str
Default:: ''

If given, this must be the name of an image file (path relative to the configuration directory) that is the logo of the documentation. It is placed at the top of the title page.

latex_toplevel_sectioning¶

Type:: 'part' | 'chapter' | 'section'
Default:: None

This value determines the topmost sectioning unit. The default setting is 'section' if latex_theme is 'howto', and 'chapter' if it is 'manual'. The alternative in both cases is to specify 'part', which means that LaTeX document will use the \part command.

In that case the numbering of sectioning units one level deep gets off-sync with HTML numbering, as by default LaTeX does not reset \chapter numbering (or \section for 'howto' theme) when encountering \part command.

Added in version 1.4.

latex_appendices¶

Type:: Sequence[str]
Default:: ()

A list of document names to append as an appendix to all manuals. This is ignored if latex_theme is set to 'howto'.

latex_domain_indices¶

Type:: bool | Sequence[str]
Default:: True

If True, generate domain-specific indices in addition to the general index. For e.g. the Python domain, this is the global module index.

This value can be a Boolean 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'.

Example:

latex_domain_indices = {
    'py-modindex',
}

Added in version 1.0.

Geändert in Version 7.4: Permit and prefer a set type.

latex_show_pagerefs¶

Type:: bool
Default:: False

Add page references after internal references. This is very useful for printed copies of the manual.

Added in version 1.0.

latex_show_urls¶

Type:: 'no' | 'footnote' | 'inline'
Default:: 'no'

Control how 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
'footnote': Display URLs in footnotes
'inline': Display URLs inline in parentheses

Added in version 1.0.

Geändert in Version 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¶

Type:: bool
Default:: False

Use standard LaTeX’s \multicolumn for merged cells in tables.

False: 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 the tabularcolumns directive was used to inject LaTeX mark-up of the type >{..}, <{..}, @{..} as column specification.
True: Use LaTeX’s standard \multicolumn; this is incompatible with literal blocks in horizontally merged cells, and also with multiple paragraphs in such cells if the table is rendered using tabulary.

Added in version 1.6.

latex_table_style¶

Type:: list[str]
Default:: ['booktabs', 'colorrows']

A list of styling classes (strings). Currently supported:

'booktabs': No vertical lines, and only 2 or 3 horizontal lines (the latter if there is a header), using the booktabs package.
'borderless': No lines whatsoever.
'colorrows': The table rows are rendered with alternating background colours. The interface to customise them is via dedicated keys of The sphinxsetup configuration setting.

Wichtig

With the 'colorrows' style, the \rowcolors LaTeX command becomes a no-op (this command has limitations and has never correctly supported all types of tables Sphinx produces in LaTeX). Please update your project to use the latex table color configuration keys instead.

To customise the styles for a table, use the :class: option if the table is defined using a directive, or otherwise insert a rst-class directive before the table (cf. Tables).

Currently recognised classes are booktabs, borderless, standard, colorrows, nocolorrows. The latter two can be combined with any of the first three. The standard class produces tables with both horizontal and vertical lines (as has been the default so far with Sphinx).

A single-row multi-column merged cell will obey the row colour, if it is set. See also TableMergeColor{Header,Odd,Even} in the The sphinxsetup configuration setting section.

Bemerkung

It is hard-coded in LaTeX that a single cell will obey the row colour even if there is a column colour set via \columncolor from a column specification (see tabularcolumns). Sphinx provides \sphinxnorowcolor which can be used in a table column specification like this:
```
>{\columncolor{blue}\sphinxnorowcolor}
```
Sphinx also provides \sphinxcolorblend, which however requires the xcolor package. Here is an example:
```
>{\sphinxcolorblend{!95!red}}
```
It means that in this column, the row colours will be slightly tinted by red; refer to xcolor documentation for more on the syntax of its \blendcolors command (a \blendcolors in place of \sphinxcolorblend would modify colours of the cell contents, not of the cell background colour panel…). You can find an example of usage in the Deprecated APIs section of this document in PDF format.

Hinweis

If you want to use a special colour for the contents of the cells of a given column use >{\noindent\color{<color>}}, possibly in addition to the above.
Multi-row merged cells, whether single column or multi-column currently ignore any set column, row, or cell colour.
It is possible for a simple cell to set a custom colour via the raw directive and the \cellcolor LaTeX command used anywhere in the cell contents. This currently is without effect in a merged cell, whatever its kind.

Hinweis

In a document not using 'booktabs' globally, it is possible to style an individual table via the booktabs class, but it will be necessary to add r'\usepackage{booktabs}' to the LaTeX preamble.

On the other hand one can use colorrows class for individual tables with no extra package (as Sphinx since 5.3.0 always loads colortbl).

Added in version 5.3.0.

Geändert in Version 6.0.0: Modify default from [] to ['booktabs', 'colorrows'].

latex_use_xindy¶

Type:: bool
Default:: True if latex_engine in {'xelatex', 'lualatex'} else False

Use Xindy to prepare the index of general terms. By default, the LaTeX builder uses makeindex for preparing the index of general terms . Using Xindy means that words with UTF-8 characters will be ordered correctly for the language.

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 creates .ind files containing invalid bytes for the UTF-8 encoding if any indexed term starts with a non-ASCII character. With 'lualatex' this then breaks the PDF build.
The default is False for 'pdflatex', but True is recommended for non-English documents as soon as some indexed terms use non-ASCII characters from the language script. Attempting to index a term whose first character is non-ASCII will break the build, if latex_use_xindy is left to its default False.

Sphinx adds some dedicated support to the xindy base distribution for using 'pdflatex' engine with Cyrillic scripts. With both 'pdflatex' and Unicode engines, Cyrillic documents handle the indexing of Latin names correctly, even those having diacritics.

Added in version 1.8.

latex_elements¶

Type:: dict[str, str]
Default:: {}

Added in version 0.5.

See the full documentation for latex_elements.

latex_docclass¶

Type:: dict[str, str]
Default:: {}

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'.

Added in version 1.0.

Geändert in Version 1.5: In Japanese documentation (language is 'ja'), by default 'jreport' is used for 'howto' and 'jsbook' for 'manual'.

latex_additional_files¶

Type:: Sequence[str]
Default:: ()

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, or to overwrite Sphinx LaTeX support files with custom versions. Image files that are referenced in source files (e.g. via .. image::) are copied automatically and should not be listed there.

Achtung

Filenames with the .tex extension will be automatically handed over to the PDF build process triggered by sphinx-build -M latexpdf or by make latexpdf. If the file was added only to be \input{} from a modified preamble, you must add a further suffix such as .txt to the filename and adjust the \input{} macro accordingly.

Added in version 0.6.

Geändert in Version 1.2: This overrides the files provided from Sphinx such as sphinx.sty.

latex_theme¶

Type:: str
Default:: 'manual'

The „theme“ that the LaTeX output should use. It is a collection of settings for LaTeX output (e.g. document class, top level sectioning unit and so on).

The bundled first-party LaTeX themes are manual and howto:

manual: A LaTeX theme for writing a manual. It imports the report document class (Japanese documents use jsbook).
howto: A LaTeX theme for writing an article. It imports the article document class (Japanese documents use jreport). latex_appendices is only available for this theme.

Added in version 3.0.

latex_theme_options¶

Type:: dict[str, Any]
Default:: {}

A dictionary of options that influence the look and feel of the selected theme. These are theme-specific.

Added in version 3.1.

latex_theme_path¶

Type:: list[str]
Default:: []

A list of paths that contain custom LaTeX themes as subdirectories. Relative paths are taken as relative to the configuration directory.

Added in version 3.0.

Options for text output¶

These options influence text output.

text_add_secnumbers¶

Type:: bool
Default:: True

Include section numbers in text output.

Added in version 1.7.

text_newlines¶

Type:: 'unix' | 'windows' | 'native'
Default:: 'unix'

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.

Added in version 1.1.

text_secnumber_suffix¶

Type:: str
Default:: '. '

Suffix for section numbers in text output. Set to ' ' to suppress the final dot on section numbers.

Added in version 1.7.

text_sectionchars¶

Type:: str
Default:: '*=-~"+`'

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.

Added in version 1.1.

Options for manual page output¶

These options influence manual page output.

man_pages¶

Type:: Sequence[tuple[str, str, str, str, str]]
Default:: The default manual 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 page. (If you want to use the default master document for your manual pages build, provide 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. Can be an empty string if you do not want to automatically generate 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.

Added in version 1.0.

man_show_urls¶

Type:: bool
Default:: False

Add URL addresses after links.

Added in version 1.1.

man_make_section_directory¶

Type:: bool
Default:: True

Make a section directory on build man page.

Added in version 3.3.

Geändert in Version 4.0: The default is now False (previously True).

Geändert in Version 4.0.2: Revert the change in the default.

Options for Texinfo output¶

These options influence Texinfo output.

texinfo_documents¶

Type:: Sequence[tuple[str, str, str, str, str, str, str, bool]]
Default:: The default 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 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 or False. 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.

Added in version 1.1.

texinfo_appendices¶

Type:: Sequence[str]
Default:: []

A list of document names to append as an appendix to all manuals.

Added in version 1.1.

texinfo_cross_references¶

Type:: bool
Default:: True

Generate inline references in a document. Disabling inline references can make an info file more readable with a stand-alone reader (info).

Added in version 4.4.

texinfo_domain_indices¶

Type:: bool | Sequence[str]
Default:: True

If True, generate domain-specific indices in addition to the general index. For e.g. the Python domain, this is the global module index.

This value can be a Boolean 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'.

Example:

texinfo_domain_indices = {
    'py-modindex',
}

Added in version 1.1.

Geändert in Version 7.4: Permit and prefer a set type.

texinfo_elements¶

Type:: dict[str, Any]
Default:: {}

A dictionary that contains Texinfo snippets that override those that 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. Specify 0 for no indentation.

'exampleindent'
Number of spaces to indent the lines for examples or literal blocks, default 4. Specify 0 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', and 'title'.

Added in version 1.1.

texinfo_no_detailmenu¶

Type:: bool
Default:: False

Do not generate a @detailmenu in the „Top“ node’s menu containing entries for each sub-node in the document.

Added in version 1.2.

texinfo_show_urls¶

Type:: 'footnote' | 'no' | 'inline'
Default:: 'footnote'

Control how to display URL addresses. The setting can have the following values:

'footnote': Display URLs in footnotes.
'no': Do not display URLs.
'inline': Display URLs inline in parentheses.

Added in version 1.1.

Options for QtHelp output¶

These options influence qthelp output. This builder derives from the HTML builder, so the HTML options also apply where appropriate.

qthelp_basename¶

Type:: str
Default:: The value of project

The basename for the qthelp file.

qthelp_namespace¶

Type:: str
Default:: 'org.sphinx.{project_name}.{project_version}'

The namespace for the qthelp file.

qthelp_theme¶

Type:: str
Default:: 'nonav'

The HTML theme for the qthelp output.

qthelp_theme_options¶

Type:: dict[str, Any]
Default:: {}

A dictionary of options that influence the look and feel of the selected theme. These are theme-specific. The options understood by the builtin themes are described here.

Options for XML output¶

xml_pretty¶

Type:: bool
Default:: True

Pretty-print the XML.

Added in version 1.2.

Options for the linkcheck builder¶

Filtering¶

These options control which links the linkcheck builder checks, and which failures and redirects it ignores.

linkcheck_allowed_redirects¶

Type:: dict[str, str]
Default:: {}

A dictionary that maps a pattern of the source URI to a pattern of the canonical URI. The linkcheck builder treats the redirected link as „working“ when:

the link in the document matches the source URI pattern, and
the redirect location matches the canonical URI pattern.

The linkcheck builder will emit a warning when it finds redirected links that don’t meet the rules above. It can be useful to detect unexpected redirects when using the fail-on-warnings mode.

Example:

linkcheck_allowed_redirects = {
    # All HTTP redirections from the source URI to
    # the canonical URI will be treated as "working".
    r'https://sphinx-doc\.org/.*': r'https://sphinx-doc\.org/en/master/.*'
}

Added in version 4.1.

linkcheck_anchors¶

Type:: bool
Default:: True

Check the validity of #anchors in links. Since this requires downloading the whole document, it is considerably slower when enabled.

Added in version 1.2.

linkcheck_anchors_ignore¶

Type:: Sequence[str]
Default:: ["^!"]

A list of regular expressions that match anchors that the linkcheck builder should skip when checking the validity of anchors in links. For example, this allows skipping anchors added by a website’s JavaScript.

Tipp

Use linkcheck_anchors_ignore_for_url to check a URL, but skip verifying that the anchors exist.

Bemerkung

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 = [
   'https://www.sphinx-doc.org/en/1.7/intro.html#',
]

Added in version 1.5.

linkcheck_anchors_ignore_for_url¶

Type:: Sequence[str]
Default:: ()

A list or tuple of regular expressions matching URLs for which the linkcheck builder should not check the validity of anchors. This allows skipping anchor checks on a per-page basis while still checking the validity of the page itself.

Added in version 7.1.

linkcheck_exclude_documents¶

Type:: Sequence[str]
Default:: ()

A list of regular expressions that match documents in which the linkcheck builder should not check the validity of links. This can be used for permitting link decay in legacy or historical sections of the documentation.

Example:

# ignore all links in documents located in a subdirectory named 'legacy'
linkcheck_exclude_documents = [r'.*/legacy/.*']

Added in version 4.4.

linkcheck_ignore¶

Type:: Sequence[str]
Default:: ()

A list of regular expressions that match URIs that should not be checked when doing a linkcheck build.

Example:

linkcheck_ignore = [r'https://localhost:\d+/']

Added in version 1.1.

HTTP Requests¶

These options control how the linkcheck builder makes HTTP requests, including how it handles redirects and authentication, and the number of workers to use.

linkcheck_auth¶

Type:: Sequence[tuple[str, Any]]
Default:: []

Pass authentication information when doing a linkcheck build.

A list of (regex_pattern, auth_info) tuples where the items are:

regex_pattern: A regular expression that matches a URI.
auth_info: Authentication information to use for that URI. The value can be anything that is understood by the requests library (see requests authentication for details).

The linkcheck builder will use the first matching auth_info value it can find in the linkcheck_auth list, so values earlier in the list have higher priority.

Example:

linkcheck_auth = [
  ('https://foo\.yourcompany\.com/.+', ('johndoe', 'secret')),
  ('https://.+\.yourcompany\.com/.+', HTTPDigestAuth(...)),
]

Added in version 2.3.

linkcheck_allow_unauthorized¶

Type:: bool
Default:: False

When a webserver responds with an HTTP 401 (unauthorised) response, the current default behaviour of the linkcheck builder is to treat the link as „broken“. To change that behaviour, set this option to True.

Geändert in Version 8.0: The default value for this option changed to False, meaning HTTP 401 responses to checked hyperlinks are treated as „broken“ by default.

Added in version 7.3.

linkcheck_rate_limit_timeout¶

Type:: int
Default:: 300

The linkcheck builder may issue a large number of requests to the same site over a short period of time. This setting controls the builder behaviour when servers indicate that requests are rate-limited, by setting the maximum duration (in seconds) that the builder will wait for between each attempt before recording a failure.

The linkcheck builder always respects a server’s direction of when to retry (using the Retry-After header). Otherwise, linkcheck waits for a minute before to retry and keeps doubling the wait time between attempts until it succeeds or exceeds the linkcheck_rate_limit_timeout (in seconds). Custom timeouts should be given as a number of seconds.

Added in version 3.4.

linkcheck_report_timeouts_as_broken¶

Type:: bool
Default:: False

If linkcheck_timeout expires while waiting for a response from a hyperlink, the linkcheck builder will report the link as a timeout by default. To report timeouts as broken instead, you can set linkcheck_report_timeouts_as_broken to True.

Geändert in Version 8.0: The default value for this option changed to False, meaning timeouts that occur while checking hyperlinks will be reported using the new ‚timeout‘ status code.

Added in version 7.3.

linkcheck_request_headers¶

Type:: dict[str, dict[str, str]]
Default:: {}

A dictionary that maps URL (without paths) to HTTP request headers.

The key is a URL base string like 'https://www.sphinx-doc.org/'. To specify headers for other hosts, "*" can be used. It matches all hosts only when the URL does not match other settings.

The value is a dictionary that maps header name to its value.

Example:

linkcheck_request_headers = {
    "https://www.sphinx-doc.org/": {
        "Accept": "text/html",
        "Accept-Encoding": "utf-8",
    },
    "*": {
        "Accept": "text/html,application/xhtml+xml",
    }
}

Added in version 3.1.

linkcheck_retries¶

Type:: int
Default:: 1

The number of times the linkcheck builder will attempt to check a URL before declaring it broken.

Added in version 1.4.

linkcheck_timeout¶

Type:: int
Default:: 30

The duration, in seconds, that the linkcheck builder will wait for a response after each hyperlink request.

Added in version 1.1.

linkcheck_workers¶

Type:: int
Default:: 5

The number of worker threads to use when checking links.

Added in version 1.1.

Domain options¶

Options for the C domain¶

c_extra_keywords¶

Type:: Set[str] | Sequence[str]
Default:: ['alignas', 'alignof', 'bool', 'complex', 'imaginary', 'noreturn', 'static_assert', 'thread_local']

A list of identifiers to be recognised as keywords by the C parser.

Added in version 4.0.3.

Geändert in Version 7.4: c_extra_keywords can now be a set.

c_id_attributes¶

Type:: Sequence[str]
Default:: ()

A sequence of strings that the parser should additionally accept as attributes. For example, this can be used when #define has been used for attributes, for portability.

Example:

c_id_attributes = [
    'my_id_attribute',
]

Added in version 3.0.

Geändert in Version 7.4: c_id_attributes can now be a tuple.

c_maximum_signature_line_length¶

Type:: int | None
Default:: None

If a signature’s length in characters exceeds the number set, each parameter within the signature will be displayed on an individual logical line.

When None, there is no maximum length and the entire signature will be displayed on a single logical line.

This is a domain-specific setting, overriding maximum_signature_line_length.

Added in version 7.1.

c_paren_attributes¶

Type:: Sequence[str]
Default:: ()

A sequence of strings that the parser should additionally accept as attributes with one argument. That is, if my_align_as is in the list, then my_align_as(X) is parsed as an attribute for all strings X that have balanced braces ((), [], and {}). For example, this can be used when #define has been used for attributes, for portability.

Example:

c_paren_attributes = [
    'my_align_as',
]

Added in version 3.0.

Geändert in Version 7.4: c_paren_attributes can now be a tuple.

Options for the C++ domain¶

cpp_id_attributes¶

Type:: Sequence[str]
Default:: ()

A sequence of strings that the parser should additionally accept as attributes. For example, this can be used when #define has been used for attributes, for portability.

Example:

cpp_id_attributes = [
    'my_id_attribute',
]

Added in version 1.5.

Geändert in Version 7.4: cpp_id_attributes can now be a tuple.

cpp_index_common_prefix¶

Type:: Sequence[str]
Default:: ()

A list of prefixes that will be ignored when sorting C++ objects in the global index.

Example:

cpp_index_common_prefix = [
    'awesome_lib::',
]

Added in version 1.5.

cpp_maximum_signature_line_length¶

Type:: int | None
Default:: None

If a signature’s length in characters exceeds the number set, each parameter within the signature will be displayed on an individual logical line.

When None, there is no maximum length and the entire signature will be displayed on a single logical line.

This is a domain-specific setting, overriding maximum_signature_line_length.

Added in version 7.1.

cpp_paren_attributes¶

Type:: Sequence[str]
Default:: ()

A sequence of strings that the parser should additionally accept as attributes with one argument. That is, if my_align_as is in the list, then my_align_as(X) is parsed as an attribute for all strings X that have balanced braces ((), [], and {}). For example, this can be used when #define has been used for attributes, for portability.

Example:

cpp_paren_attributes = [
    'my_align_as',
]

Added in version 1.5.

Geändert in Version 7.4: cpp_paren_attributes can now be a tuple.

Options for the Javascript domain¶

javascript_maximum_signature_line_length¶

Type:: int | None
Default:: None

If a signature’s length in characters exceeds the number set, each parameter within the signature will be displayed on an individual logical line.

When None, there is no maximum length and the entire signature will be displayed on a single logical line.

This is a domain-specific setting, overriding maximum_signature_line_length.

Added in version 7.1.

Options for the Python domain¶

add_module_names¶

Type:: bool
Default:: True

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.

modindex_common_prefix¶

Type:: list[str]
Default:: []

A list of prefixes that are ignored for sorting the Python module index (e.g., if this is set to ['foo.'], then foo.bar is shown under B, not F). This can be handy if you document a project that consists of a single package.

Vorsicht

Works only for the HTML builder currently.

Added in version 0.6.

python_display_short_literal_types¶

Type:: bool
Default:: False

This value controls how Literal types are displayed.

Examples¶

The examples below use the following py:function directive:

.. py:function:: serve_food(item: Literal["egg", "spam", "lobster thermidor"]) -> None

When False, Literal types display as per standard Python syntax, i.e.:

serve_food(item: Literal["egg", "spam", "lobster thermidor"]) -> None

When True, Literal types display with a short, PEP 604-inspired syntax, i.e.:

serve_food(item: "egg" | "spam" | "lobster thermidor") -> None

Added in version 6.2.

python_maximum_signature_line_length¶

Type:: int | None
Default:: None

If a signature’s length in characters exceeds the number set, each parameter within the signature will be displayed on an individual logical line.

When None, there is no maximum length and the entire signature will be displayed on a single logical line.

This is a domain-specific setting, overriding maximum_signature_line_length.

For the Python domain, the signature length depends on whether the type parameters or the list of arguments are being formatted. For the former, the signature length ignores the length of the arguments list; for the latter, the signature length ignores the length of the type parameters list.

For instance, with python_maximum_signature_line_length = 20, only the list of type parameters will be wrapped while the arguments list will be rendered on a single line

.. py:function:: add[T: VERY_LONG_SUPER_TYPE, U: VERY_LONG_SUPER_TYPE](a: T, b: U)

Added in version 7.1.

python_use_unqualified_type_names¶

Type:: bool
Default:: False

Suppress the module name of the python reference if it can be resolved.

Added in version 4.0.

Vorsicht

This feature is experimental.

trim_doctest_flags¶

Type:: bool
Default:: True

Remove doctest flags (comments looking like # doctest: FLAG, ...) at the ends of lines and <BLANKLINE> markers for all code blocks showing interactive Python sessions (i.e. doctests). See the extension doctest for more possibilities of including doctests.

Added in version 1.0.

Geändert in Version 1.1: Now also removes <BLANKLINE>.

Extension options¶

Extensions frequently have their own configuration options. Those for Sphinx’s first-party extensions are documented in each extension’s page.

Example configuration file¶

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = 'Test Project'
copyright = '2000-2042, The Test Project Authors'
author = 'The Authors'
version = release = '4.16'

# -- General configuration ------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

exclude_patterns = [
    '_build',
    'Thumbs.db',
    '.DS_Store',
]
extensions = []
language = 'en'
master_doc = 'index'
pygments_style = 'sphinx'
source_suffix = '.rst'
templates_path = ['_templates']

# -- Options for HTML output ----------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = 'alabaster'
html_static_path = ['_static']