The main application class and extensibility interface. :ivar srcdir: Directory containing source. :ivar confdir: Directory containing ``conf.py``. :ivar doctreedir: Directory for storing pickled doctrees. :ivar outdir: Directory for storing build documents.
Method | __init__ |
Undocumented |
Method | add |
Register a new ``getattr``-like function for the autodoc extension. |
Method | add |
Register a new documenter class for the autodoc extension. |
Method | add |
Register a new builder. |
Method | add |
Register a configuration value. |
Method | add |
Register a new crossref object type. |
Method | add |
Register a stylesheet to include in the HTML output. |
Method | add |
Register a Docutils directive. |
Method | add |
Register a Docutils directive in a domain. |
Method | add |
Register a domain. |
Method | add |
Register a Docutils node class as a numfig target. |
Method | add |
Register an environment collector class. |
Method | add |
Register an event called *name*. |
Method | add |
Register a generic Docutils role. |
Method | add |
Register a math renderer for HTML. |
Method | add |
Register a HTML Theme. |
Method | add |
Register a custom index for a domain. |
Method | add |
Register a JavaScript file to include in the HTML output. |
Method | add |
Register a package to include in the LaTeX source code. |
Method | add |
Register a new lexer for source code. |
Method | add |
Register a message catalog. |
Method | add |
Register a Docutils node class. |
Method | add |
Register a new object type. |
Method | add |
Register a Docutils transform to be applied before writing. |
Method | add |
Register a Docutils role. |
Method | add |
Register a Docutils role in a domain. |
Method | add |
Register a new language for the HTML search index. |
Method | add |
Register a parser class. |
Method | add |
Register a suffix of source files. |
Method | add |
Register a Docutils transform to be applied after parsing. |
Method | build |
Undocumented |
Method | connect |
Register *callback* to be called when *event* is emitted. |
Method | create |
Undocumented |
Method | disconnect |
Unregister callback by *listener_id*. |
Method | emit |
Emit *event* and pass *arguments* to the callback functions. |
Method | emit |
Emit *event* and pass *arguments* to the callback functions. |
Method | is |
Check whether parallel processing is allowed or not. |
Method | preload |
Undocumented |
Method | require |
Check the Sphinx version if requested. |
Method | set |
Set the policy to include assets in HTML pages. |
Method | set |
Register or override a Docutils translator class. |
Method | setup |
Import and setup a Sphinx extension module. |
Instance Variable | builder |
Undocumented |
Instance Variable | confdir |
Undocumented |
Instance Variable | config |
Undocumented |
Instance Variable | doctreedir |
Undocumented |
Instance Variable | env |
Undocumented |
Instance Variable | events |
Undocumented |
Instance Variable | extensions |
Undocumented |
Instance Variable | keep |
Undocumented |
Instance Variable | messagelog |
Undocumented |
Instance Variable | outdir |
Undocumented |
Instance Variable | parallel |
Undocumented |
Instance Variable | pdb |
Undocumented |
Instance Variable | phase |
Undocumented |
Instance Variable | project |
Undocumented |
Instance Variable | quiet |
Undocumented |
Instance Variable | registry |
Undocumented |
Instance Variable | srcdir |
Undocumented |
Instance Variable | statuscode |
Undocumented |
Instance Variable | tags |
Undocumented |
Instance Variable | translator |
Undocumented |
Instance Variable | verbosity |
Undocumented |
Instance Variable | warningiserror |
Undocumented |
Method | _create |
Undocumented |
Method | _init |
Undocumented |
Method | _init |
Undocumented |
Method | _init |
Load translated strings from the configured localedirs if enabled in the configuration. |
Method | _load |
Undocumented |
Method | _post |
Undocumented |
Instance Variable | _fresh |
Undocumented |
Instance Variable | _status |
Undocumented |
Instance Variable | _warncount |
Undocumented |
Instance Variable | _warning |
Undocumented |
sphinx.testing.util.SphinxTestApp
Undocumented
Parameters | |
srcdir:str | Undocumented |
confdir:str|None | Undocumented |
outdir:str | Undocumented |
doctreedir:str | Undocumented |
buildername:str | Undocumented |
confoverrides:dict|None | Undocumented |
status:IO|None | Undocumented |
warning:IO|None | Undocumented |
freshenv:bool | Undocumented |
warningiserror:bool | Undocumented |
tags:list[ | Undocumented |
verbosity:int | Undocumented |
parallel:int | Undocumented |
keepbool | Undocumented |
pdb:bool | Undocumented |
Register a new ``getattr``-like function for the autodoc extension. Add *getter*, which must be a function with an interface compatible to the :func:`getattr` builtin, as the autodoc attribute getter for objects that are instances of *typ*. All cases where autodoc needs to get an attribute of a type are then handled by this function instead of :func:`getattr`. .. versionadded:: 0.6
Parameters | |
typ:type | Undocumented |
getter:Callable[ | Undocumented |
Register a new documenter class for the autodoc extension. Add *cls* as a new documenter class for the :mod:`sphinx.ext.autodoc` extension. It must be a subclass of :class:`sphinx.ext.autodoc.Documenter`. This allows auto-documenting new types of objects. See the source of the autodoc module for examples on how to subclass :class:`Documenter`. If *override* is True, the given *cls* is forcedly installed even if a documenter having the same name is already installed. See :ref:`autodoc_ext_tutorial`. .. versionadded:: 0.6 .. versionchanged:: 2.2 Add *override* keyword.
Parameters | |
cls:Any | Undocumented |
override:bool | Undocumented |
Register a configuration value. This is necessary for Sphinx to recognize new values and set default values accordingly. :param name: The name of the configuration value. It is recommended to be prefixed with the extension name (ex. ``html_logo``, ``epub_title``) :param default: The default value of the configuration. :param rebuild: The condition of rebuild. It must be one of those values: * ``'env'`` if a change in the setting only takes effect when a document is parsed -- this means that the whole environment must be rebuilt. * ``'html'`` if a change in the setting needs a full rebuild of HTML documents. * ``''`` if a change in the setting will not need any special rebuild. :param types: The type of configuration value. A list of types can be specified. For example, ``[str]`` is used to describe a configuration that takes string value. .. versionchanged:: 0.4 If the *default* value is a callable, it will be called with the config object as its argument in order to get the default value. This can be used to implement config values whose default depends on other values. .. versionchanged:: 0.6 Changed *rebuild* from a simple boolean (equivalent to ``''`` or ``'env'``) to a string. However, booleans are still accepted and converted internally.
Parameters | |
name:str | Undocumented |
default:Any | Undocumented |
rebuild:bool|str | Undocumented |
types:Any | Undocumented |
Register a new crossref object type. This method is very similar to :meth:`add_object_type` except that the directive it generates must be empty, and will produce no output. That means that you can add semantic targets to your sources, and refer to them using custom roles instead of generic ones (like :rst:role:`ref`). Example call:: app.add_crossref_type('topic', 'topic', 'single: %s', docutils.nodes.emphasis) Example usage:: .. topic:: application API The application API ------------------- Some random text here. See also :topic:`this section <application API>`. (Of course, the element following the ``topic`` directive needn't be a section.) :param override: If false, do not install it if another cross-reference type is already installed as the same name If true, unconditionally install the cross-reference type. .. versionchanged:: 1.8 Add *override* keyword.
Parameters | |
directivename:str | Undocumented |
rolename:str | Undocumented |
indextemplate:str | Undocumented |
reftype[ | Undocumented |
objname:str | Undocumented |
override:bool | Undocumented |
Register a stylesheet to include in the HTML output. :param filename: The name of a CSS file that the default HTML template will include. It must be relative to the HTML static path, or a full URI with scheme. :param priority: Files are included in ascending order of priority. If multiple CSS files have the same priority, those files will be included in order of registration. See list of "prority range for CSS files" below. :param kwargs: Extra keyword arguments are included as attributes of the ``<link>`` tag. Example:: app.add_css_file('custom.css') # => <link rel="stylesheet" href="_static/custom.css" type="text/css" /> app.add_css_file('print.css', media='print') # => <link rel="stylesheet" href="_static/print.css" # type="text/css" media="print" /> app.add_css_file('fancy.css', rel='alternate stylesheet', title='fancy') # => <link rel="alternate stylesheet" href="_static/fancy.css" # type="text/css" title="fancy" /> .. list-table:: priority range for CSS files :widths: 20,80 * - Priority - Main purpose in Sphinx * - 200 - default priority for built-in CSS files * - 500 - default priority for extensions * - 800 - default priority for :confval:`html_css_files` A CSS file can be added to the specific HTML page when an extension calls this method on :event:`html-page-context` event. .. versionadded:: 1.0 .. versionchanged:: 1.6 Optional ``alternate`` and/or ``title`` attributes can be supplied with the arguments *alternate* (a Boolean) and *title* (a string). The default is no title and *alternate* = ``False``. For more information, refer to the `documentation <https://mdn.io/Web/CSS/Alternative_style_sheets>`__. .. versionchanged:: 1.8 Renamed from ``app.add_stylesheet()``. And it allows keyword arguments as attributes of link tag. .. versionchanged:: 3.5 Take priority argument. Allow to add a CSS file to the specific page.
Parameters | |
filename:str | Undocumented |
priority:int | Undocumented |
**kwargs:Any | Undocumented |
Register a Docutils directive. :param name: The name of the directive :param cls: A directive class :param override: If false, do not install it if another directive is already installed as the same name If true, unconditionally install the directive. For example, a custom directive named ``my-directive`` would be added like this: .. code-block:: python from docutils.parsers.rst import Directive, directives class MyDirective(Directive): has_content = True required_arguments = 1 optional_arguments = 0 final_argument_whitespace = True option_spec = { 'class': directives.class_option, 'name': directives.unchanged, } def run(self): ... def setup(app): app.add_directive('my-directive', MyDirective) For more details, see `the Docutils docs <https://docutils.sourceforge.io/docs/howto/rst-directives.html>`__ . .. versionchanged:: 0.6 Docutils 0.5-style directive classes are now supported. .. deprecated:: 1.8 Docutils 0.4-style (function based) directives support is deprecated. .. versionchanged:: 1.8 Add *override* keyword.
Parameters | |
name:str | Undocumented |
cls:type[ | Undocumented |
override:bool | Undocumented |
Register a Docutils directive in a domain. Like :meth:`add_directive`, but the directive is added to the domain named *domain*. :param domain: The name of target domain :param name: A name of directive :param cls: A directive class :param override: If false, do not install it if another directive is already installed as the same name If true, unconditionally install the directive. .. versionadded:: 1.0 .. versionchanged:: 1.8 Add *override* keyword.
Parameters | |
domain:str | Undocumented |
name:str | Undocumented |
cls:type[ | Undocumented |
override:bool | Undocumented |
Register a domain. :param domain: A domain class :param override: If false, do not install it if another domain is already installed as the same name If true, unconditionally install the domain. .. versionadded:: 1.0 .. versionchanged:: 1.8 Add *override* keyword.
Parameters | |
domain:type[ | Undocumented |
override:bool | Undocumented |
Register a Docutils node class as a numfig target. Sphinx numbers the node automatically. And then the users can refer it using :rst:role:`numref`. :param node: A node class :param figtype: The type of enumerable nodes. Each figtype has individual numbering sequences. As system figtypes, ``figure``, ``table`` and ``code-block`` are defined. It is possible to add custom nodes to these default figtypes. It is also possible to define new custom figtype if a new figtype is given. :param title_getter: A getter function to obtain the title of node. It takes an instance of the enumerable node, and it must return its title as string. The title is used to the default title of references for :rst:role:`ref`. By default, Sphinx searches ``docutils.nodes.caption`` or ``docutils.nodes.title`` from the node as a title. :param kwargs: Visitor functions for each builder (same as :meth:`add_node`) :param override: If true, install the node forcedly even if another node is already installed as the same name .. versionadded:: 1.4
Parameters | |
node:type[ | Undocumented |
figtype:str | Undocumented |
titleTitleGetter|None | Undocumented |
override:bool | Undocumented |
**kwargs:tuple[ | Undocumented |
Register an environment collector class. Refer to :ref:`collector-api`. .. versionadded:: 1.6
Parameters | |
collector:type[ | Undocumented |
Register an event called *name*. This is needed to be able to emit it. :param name: The name of the event
Parameters | |
name:str | Undocumented |
Register a generic Docutils role. Register a Docutils role that does nothing but wrap its contents in the node given by *nodeclass*. :param override: If false, do not install it if another role is already installed as the same name If true, unconditionally install the role. .. versionadded:: 0.6 .. versionchanged:: 1.8 Add *override* keyword.
Parameters | |
name:str | Undocumented |
nodeclass:Any | Undocumented |
override:bool | Undocumented |
Register a math renderer for HTML. The *name* is a name of math renderer. Both *inline_renderers* and *block_renderers* are used as visitor functions for the HTML writer: the former for inline math node (``nodes.math``), the latter for block math node (``nodes.math_block``). Regarding visitor functions, see :meth:`add_node` for details. .. versionadded:: 1.8
Parameters | |
name:str | Undocumented |
inlinetuple[ | Undocumented |
blocktuple[ | Undocumented |
Register a custom index for a domain. Add a custom *index* class to the domain named *domain*. :param domain: The name of the target domain :param index: The index class :param override: If false, do not install it if another index is already installed as the same name If true, unconditionally install the index. .. versionadded:: 1.0 .. versionchanged:: 1.8 Add *override* keyword.
Parameters | |
domain:str | Undocumented |
index:type[ | Undocumented |
override:bool | Undocumented |
Register a JavaScript file to include in the HTML output. :param filename: The name of a JavaScript file that the default HTML template will include. It must be relative to the HTML static path, or a full URI with scheme, or ``None`` . The ``None`` value is used to create an inline ``<script>`` tag. See the description of *kwargs* below. :param priority: Files are included in ascending order of priority. If multiple JavaScript files have the same priority, those files will be included in order of registration. See list of "prority range for JavaScript files" below. :param loading_method: The loading method for the JavaScript file. Either ``'async'`` or ``'defer'`` are allowed. :param kwargs: Extra keyword arguments are included as attributes of the ``<script>`` tag. If the special keyword argument ``body`` is given, its value will be added as the content of the ``<script>`` tag. Example:: app.add_js_file('example.js') # => <script src="_static/example.js"></script> app.add_js_file('example.js', loading_method="async") # => <script src="_static/example.js" async="async"></script> app.add_js_file(None, body="var myVariable = 'foo';") # => <script>var myVariable = 'foo';</script> .. list-table:: priority range for JavaScript files :widths: 20,80 * - Priority - Main purpose in Sphinx * - 200 - default priority for built-in JavaScript files * - 500 - default priority for extensions * - 800 - default priority for :confval:`html_js_files` A JavaScript file can be added to the specific HTML page when an extension calls this method on :event:`html-page-context` event. .. versionadded:: 0.5 .. versionchanged:: 1.8 Renamed from ``app.add_javascript()``. And it allows keyword arguments as attributes of script tag. .. versionchanged:: 3.5 Take priority argument. Allow to add a JavaScript file to the specific page. .. versionchanged:: 4.4 Take loading_method argument. Allow to change the loading method of the JavaScript file.
Parameters | |
filename:str|None | Undocumented |
priority:int | Undocumented |
loadingstr|None | Undocumented |
**kwargs:Any | Undocumented |
Register a package to include in the LaTeX source code. Add *packagename* to the list of packages that LaTeX source code will include. If you provide *options*, it will be taken to the `\usepackage` declaration. If you set *after_hyperref* truthy, the package will be loaded after ``hyperref`` package. .. code-block:: python app.add_latex_package('mypackage') # => \usepackage{mypackage} app.add_latex_package('mypackage', 'foo,bar') # => \usepackage[foo,bar]{mypackage} .. versionadded:: 1.3 .. versionadded:: 3.1 *after_hyperref* option.
Parameters | |
packagename:str | Undocumented |
options:str|None | Undocumented |
afterbool | Undocumented |
Register a new lexer for source code. Use *lexer* to highlight code blocks with the given language *alias*. .. versionadded:: 0.6 .. versionchanged:: 2.1 Take a lexer class as an argument. An instance of lexers are still supported until Sphinx-3.x.
Parameters | |
alias:str | Undocumented |
lexer:type[ | Undocumented |
Register a Docutils node class. This is necessary for Docutils internals. It may also be used in the future to validate nodes in the parsed documents. :param node: A node class :param kwargs: Visitor functions for each builder (see below) :param override: If true, install the node forcedly even if another node is already installed as the same name Node visitor functions for the Sphinx HTML, LaTeX, text and manpage writers can be given as keyword arguments: the keyword should be one or more of ``'html'``, ``'latex'``, ``'text'``, ``'man'``, ``'texinfo'`` or any other supported translators, the value a 2-tuple of ``(visit, depart)`` methods. ``depart`` can be ``None`` if the ``visit`` function raises :exc:`docutils.nodes.SkipNode`. Example: .. code-block:: python class math(docutils.nodes.Element): pass def visit_math_html(self, node): self.body.append(self.starttag(node, 'math')) def depart_math_html(self, node): self.body.append('</math>') app.add_node(math, html=(visit_math_html, depart_math_html)) Obviously, translators for which you don't specify visitor methods will choke on the node when encountered in a document to translate. .. versionchanged:: 0.5 Added the support for keyword arguments giving visit functions.
Parameters | |
node:type[ | Undocumented |
override:bool | Undocumented |
**kwargs:tuple[ | Undocumented |
Register a new object type. This method is a very convenient way to add a new :term:`object` type that can be cross-referenced. It will do this: - Create a new directive (called *directivename*) for documenting an object. It will automatically add index entries if *indextemplate* is nonempty; if given, it must contain exactly one instance of ``%s``. See the example below for how the template will be interpreted. - Create a new role (called *rolename*) to cross-reference to these object descriptions. - If you provide *parse_node*, it must be a function that takes a string and a docutils node, and it must populate the node with children parsed from the string. It must then return the name of the item to be used in cross-referencing and index entries. See the :file:`conf.py` file in the source for this documentation for an example. - The *objname* (if not given, will default to *directivename*) names the type of object. It is used when listing objects, e.g. in search results. For example, if you have this call in a custom Sphinx extension:: app.add_object_type('directive', 'dir', 'pair: %s; directive') you can use this markup in your documents:: .. rst:directive:: function Document a function. <...> See also the :rst:dir:`function` directive. For the directive, an index entry will be generated as if you had prepended :: .. index:: pair: function; directive The reference node will be of class ``literal`` (so it will be rendered in a proportional font, as appropriate for code) unless you give the *ref_nodeclass* argument, which must be a docutils node class. Most useful are ``docutils.nodes.emphasis`` or ``docutils.nodes.strong`` -- you can also use ``docutils.nodes.generated`` if you want no further text decoration. If the text should be treated as literal (e.g. no smart quote replacement), but not have typewriter styling, use ``sphinx.addnodes.literal_emphasis`` or ``sphinx.addnodes.literal_strong``. For the role content, you have the same syntactical possibilities as for standard Sphinx roles (see :ref:`xref-syntax`). If *override* is True, the given object_type is forcedly installed even if an object_type having the same name is already installed. .. versionchanged:: 1.8 Add *override* keyword.
Parameters | |
directivename:str | Undocumented |
rolename:str | Undocumented |
indextemplate:str | Undocumented |
parseCallable|None | Undocumented |
reftype[ | Undocumented |
objname:str | Undocumented |
doclist | Undocumented |
override:bool | Undocumented |
Register a Docutils role. :param name: The name of role :param role: A role function :param override: If false, do not install it if another role is already installed as the same name If true, unconditionally install the role. For more details about role functions, see `the Docutils docs <https://docutils.sourceforge.io/docs/howto/rst-roles.html>`__ . .. versionchanged:: 1.8 Add *override* keyword.
Parameters | |
name:str | Undocumented |
role:Any | Undocumented |
override:bool | Undocumented |
Register a Docutils role in a domain. Like :meth:`add_role`, but the role is added to the domain named *domain*. :param domain: The name of the target domain :param name: The name of the role :param role: The role function :param override: If false, do not install it if another role is already installed as the same name If true, unconditionally install the role. .. versionadded:: 1.0 .. versionchanged:: 1.8 Add *override* keyword.
Parameters | |
domain:str | Undocumented |
name:str | Undocumented |
role:RoleFunction|XRefRole | Undocumented |
override:bool | Undocumented |
Register a new language for the HTML search index. Add *cls*, which must be a subclass of :class:`sphinx.search.SearchLanguage`, as a support language for building the HTML full-text search index. The class must have a *lang* attribute that indicates the language it should be used for. See :confval:`html_search_language`. .. versionadded:: 1.1
Parameters | |
cls:Any | Undocumented |
Register a parser class. :param override: If false, do not install it if another parser is already installed for the same suffix. If true, unconditionally install the parser. .. versionadded:: 1.4 .. versionchanged:: 1.8 *suffix* argument is deprecated. It only accepts *parser* argument. Use :meth:`add_source_suffix` API to register suffix instead. .. versionchanged:: 1.8 Add *override* keyword.
Parameters | |
parser:type[ | Undocumented |
override:bool | Undocumented |
Register a suffix of source files. Same as :confval:`source_suffix`. The users can override this using the config setting. :param override: If false, do not install it the same suffix is already installed. If true, unconditionally install the suffix. .. versionadded:: 1.8
Parameters | |
suffix:str | Undocumented |
filetype:str | Undocumented |
override:bool | Undocumented |
Register a Docutils transform to be applied after parsing. Add the standard docutils :class:`Transform` subclass *transform* to the list of transforms that are applied after Sphinx parses a reST document. :param transform: A transform class .. list-table:: priority range categories for Sphinx transforms :widths: 20,80 * - Priority - Main purpose in Sphinx * - 0-99 - Fix invalid nodes by docutils. Translate a doctree. * - 100-299 - Preparation * - 300-399 - early * - 400-699 - main * - 700-799 - Post processing. Deadline to modify text and referencing. * - 800-899 - Collect referencing and referenced nodes. Domain processing. * - 900-999 - Finalize and clean up. refs: `Transform Priority Range Categories`__ __ https://docutils.sourceforge.io/docs/ref/transforms.html#transform-priority-range-categories
Parameters | |
transform:type[ | Undocumented |
Register *callback* to be called when *event* is emitted. For details on available core events and the arguments of callback functions, please see :ref:`events`. :param event: The name of target event :param callback: Callback function for the event :param priority: The priority of the callback. The callbacks will be invoked in order of *priority* (ascending). :return: A listener ID. It can be used for :meth:`disconnect`. .. versionchanged:: 3.0 Support *priority*
Parameters | |
event:str | Undocumented |
callback:Callable | Undocumented |
priority:int | Undocumented |
Returns | |
int | Undocumented |
Unregister callback by *listener_id*. :param listener_id: A listener_id that :meth:`connect` returns
Parameters | |
listenerint | Undocumented |
Emit *event* and pass *arguments* to the callback functions. Return the return values of all callbacks as a list. Do not emit core Sphinx events in extensions! :param event: The name of event that will be emitted :param args: The arguments for the event :param allowed_exceptions: The list of exceptions that are allowed in the callbacks .. versionchanged:: 3.1 Added *allowed_exceptions* to specify path-through exceptions
Parameters | |
event:str | Undocumented |
*args:Any | Undocumented |
allowedtuple[ | Undocumented |
Returns | |
list | Undocumented |
Emit *event* and pass *arguments* to the callback functions. Return the result of the first callback that doesn't return ``None``. :param event: The name of event that will be emitted :param args: The arguments for the event :param allowed_exceptions: The list of exceptions that are allowed in the callbacks .. versionadded:: 0.5 .. versionchanged:: 3.1 Added *allowed_exceptions* to specify path-through exceptions
Parameters | |
event:str | Undocumented |
*args:Any | Undocumented |
allowedtuple[ | Undocumented |
Returns | |
Any | Undocumented |
Check the Sphinx version if requested. Compare *version* with the version of the running Sphinx, and abort the build when it is too old. :param version: The required version in the form of ``major.minor``. .. versionadded:: 1.0
Parameters | |
version:str | Undocumented |
Set the policy to include assets in HTML pages. - always: include the assets in all the pages - per_page: include the assets only in pages where they are used .. versionadded: 4.1
Register or override a Docutils translator class. This is used to register a custom output translator or to replace a builtin translator. This allows extensions to use a custom translator and define custom nodes for the translator (see :meth:`add_node`). :param name: The name of the builder for the translator :param translator_class: A translator class :param override: If true, install the translator forcedly even if another translator is already installed as the same name .. versionadded:: 1.3 .. versionchanged:: 1.8 Add *override* keyword.
Parameters | |
name:str | Undocumented |
translatortype[ | Undocumented |
override:bool | Undocumented |
Import and setup a Sphinx extension module. Load the extension given by the module *name*. Use this if your extension needs the features provided by another extension. No-op if called twice.
Parameters | |
extname:str | Undocumented |