3
T'ícã× ã 5 @ sX d Z ddlZddlZddlZddlZddlmZ ddlmZ ddlm Z ddl
m Z m Z m
Z
mZmZmZmZmZmZmZ ddlmZ ddlmZmZ dd lmZ dd
l m Z m Z dd l m Z dd l!m"Z" ddl#Z#dd
l#m$Z$m%Z% ddl&m'Z' ddl(m)Z) ddl*m+Z+m,Z, ddl-m.Z. ddl/m0Z0 ddl1m2Z2m3Z3m4Z4 ddl5m6Z6 ddl7m8Z8 ddl9m:Z: ddl;m<Z< ddl=m>Z> ddl?m@Z@ ddlAmBZB ddlCmDZD dd lEmZmFZFmGZG dd lHmIZI dd lJmKZK dd lLmMZM dd lNmOZO dd!lPmQZQmRZRmSZS dd"lTmUZU dd#lVmWZWmXZX e r&dd$lmYZY dd%lZm[Z[ d`Z\d[Z]eFj^e_Z`G d\d] d]ZaG d^d_ d_ZbdS )aznSphinx application class and extensibility interface.
Gracefully adapted from the TextPress system by Armin.
é N)Údeque)ÚStringIO)Úpath)
ÚIOÚ
TYPE_CHECKINGÚAnyÚCallableÚDictÚListÚOptionalÚTupleÚTypeÚUnion)Únodes)ÚElementÚ TextElement)ÚParser)Ú DirectiveÚroles)Ú Transform)ÚLexer)ÚlocaleÚ package_dir)ÚConfig)ÚRemovedInSphinx60Warning)ÚDomainÚIndex)ÚBuildEnvironment)ÚEnvironmentCollector)ÚApplicationErrorÚ ConfigErrorÚVersionRequirementError)Ú EventManager)Ú Extension)Ú
lexer_classes)Ú__)ÚProject)ÚSphinxComponentRegistry)ÚXRefRole)ÚTheme)ÚdocutilsÚloggingÚprogress_message)Ú
BuildPhase)Úbold)ÚCatalogRepository)Úprefixed_warnings)ÚabspathÚ ensuredirÚrelpath)ÚTags)Ú RoleFunctionÚ TitleGetter)ÚNode)ÚBuilderúsphinx.addnodesúsphinx.builders.changesúsphinx.builders.epub3úsphinx.builders.dirhtmlúsphinx.builders.dummyúsphinx.builders.gettextúsphinx.builders.htmlúsphinx.builders.latexúsphinx.builders.linkcheckúsphinx.builders.manpageúsphinx.builders.singlehtmlúsphinx.builders.texinfoúsphinx.builders.textúsphinx.builders.xmlú
sphinx.configúsphinx.domains.cúsphinx.domains.changesetúsphinx.domains.citationúsphinx.domains.cppúsphinx.domains.indexúsphinx.domains.javascriptúsphinx.domains.mathúsphinx.domains.pythonúsphinx.domains.rstúsphinx.domains.stdúsphinx.directivesúsphinx.directives.codeúsphinx.directives.otherúsphinx.directives.patchesúsphinx.extensionúsphinx.parsersúsphinx.registryú sphinx.rolesúsphinx.transformsú%sphinx.transforms.compact_bullet_listúsphinx.transforms.i18nú sphinx.transforms.referencesú!sphinx.transforms.post_transformsú&sphinx.transforms.post_transforms.codeú(sphinx.transforms.post_transforms.imagesúsphinx.util.compatúsphinx.versioningú*sphinx.environment.collectors.dependenciesú#sphinx.environment.collectors.assetú&sphinx.environment.collectors.metadataú#sphinx.environment.collectors.titleú%sphinx.environment.collectors.toctreeúsphinxcontrib.applehelpúsphinxcontrib.devhelpúsphinxcontrib.htmlhelpú sphinxcontrib.serializinghtmlúsphinxcontrib.qthelpÚ alabasterzenvironment.picklec @ s® e Zd ZU dZeedej ej
ddddddf e e e e e e e
eeeeee eeeddddZddd d
Zedd d d
Ze ddddZe ddddZddddZdeee ddddZe ddddZe dd d d Zde eeed d!d"Zedd#d$d%Zf d&e e e e e d'f ed(d)d*Z f d&e e e e e d'f e d(d+d,Z!de d edd-d.d/Z"f fe e e#ee f e dd0d1d2Z$e ddd3d4Z%de e e&j' edd5d6d7Z(de e) ee ee e f dd8d9d:Z*de e) e e+ee eef dd;d<d=Z,de e e- edd>d?d@Z.de e eddAdBdCZ/de e eddDdEdFZ0de e1 eddGdHdIZ2de e e e- eddJdKdLZ3de e e#e4e5f eddMdNdOZ6de e e7 eddPdQdRZ8dSdddSg dfe e e ee e9 e eeddT dUdVZ:de e e e e9 e eddWdXdYZ;e e< ddZd[d\Z=e e< ddZd]d^Z>de ee e e dd_d`daZ?de ee ddbdcddZ@d e ee ddedfdgZAd¡e e eddhdidjZBe e eC ddkdldmZDd¢e eddndodpZEe ee e e ge f ddqdrdsZFe ddtdudvZGd£e e eddwdxdyZHd¤e eI eddzd{d|ZJe eK dd}d~dZLe e ddddZMd¥e e eef e eef dddd
ZNe e ddddZOe edddZPdd ZQeRe
e e f dddZSdS )¦ÚSphinxa 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.
NFr )ÚsrcdirÚconfdirÚoutdirÚ
doctreedirÚ buildernameÚ
confoverridesÚstatusÚwarningÚfreshenvÚwarningiserrorÚtagsÚ verbosityÚparallelÚ
keep_goingÚreturnc C sþ t j| _| | _i | _d | _d | _d | _t | _ t
|| _ t
|| _ t
|| _
tj| j sjttd| j tj| j rtj| j rttd| j | j | j kr®ttd|
| _|d krÌt | _d| _n || _d| _|d krêt | _n|| _d| _|
oü|| _| jrd| _n|
| _tj | | j| j t | | _ t dd| _ t!j"t#td t$j% d| _&t'| | _(|d kr| j | _)t*i |pi | _+n$t
|| _)t*j,| j)|p¦i | j(| _+| j+j- | j. | j+j/rð| j+j/t$j%krðt0td
| j+j/ xt1D ]}| j2| qöW x | j+jD ]}| j2| qW | j3| tj|s^t4td t5| W d Q R X | j+j r°td d
}t6|. t7| j+j r| j+j | n t8tdW d Q R X | j+j9 | j j:d| j+ t;| j | j+j<| _| j=|| _| j>| | j? d S )Nz!Cannot find source directory (%s)z(Output directory (%s) is not a directoryz>Source directory and destination directory cannot be identicalTFr é
)ÚmaxlenzRunning Sphinx v%szWThis project needs at least Sphinx v%s and therefore cannot be built with this version.zmaking output directoryz while setting up extension %s:zconf.pyz¹'setup' as currently defined in conf.py isn't a Python callable. Please modify its definition to make it a callable function. This is needed for conf.py to behave as a Sphinx extension.z
config-inited)@r- ZINITIALIZATIONÚphaserz Ú
extensionsÚbuilderÚenvÚprojectr' Úregistryr1 ro rq rr r Úisdirr r% Úexistsr{ r Z_statusÚquietZ_warningÚ
_warncountr| rx r+ Úsetupr" Úeventsr Z
messagelogÚloggerÚinfor. ÚsphinxÚ__display_version__Ú
statuscoder4 ry rp r ÚconfigÚreadZpre_init_valuesÚ
_init_i18nZ needs_sphinxr! Úbuiltin_extensionsÚsetup_extensionÚpreload_builderr, r2 r0 Úcallabler Z init_valuesÚemitr& Z
source_suffixÚcreate_builderÚ _init_envÚ
_init_builder)Úselfro rp rq rr rs rt ru rv rw rx ry rz r{ r| Ú extensionÚprefix© r ú4/tmp/pip-build-gk9425m9/sphinx/sphinx/application.pyÚ__init__ s
zSphinx.__init__)r} c C sþ | j jdkr tjg d\| _}nÚtjttd| j j dd t | j
| j j | j j| j j }x4|j
D ]*}|jdkrb|j rb|j| j j| j j qbW t|j }|dg7 }|tjtdg7 }tj|| j j\| _}|sÜ| j jdkrìtjtd ntjtd dS )
zhLoad translated strings from the configured localedirs if enabled in
the configuration.
Nz loading translations [%s]... T)Znonlr r ÚenÚdonez#not available for built-in messages)r Úlanguager ÚinitZ
translatorr r r. r% r/ ro Ú locale_dirsZsource_encodingZcatalogsÚdomainZ is_outdatedZwrite_moZ gettext_allow_fuzzy_translationsÚlistr Újoinr )r Zhas_translationÚrepoÚcatalogr¦ r r r r s"
zSphinx._init_i18n)rw r} c C sÌ t j| jt}|s tj j| r>t| | _| jj| j | j
nyJt t d4 t
|d }tj|| _| jj| W d Q R X W d Q R X W n> tk
rÆ } z"tjt d| | jdd W Y d d }~X nX d S )Nzloading pickled environmentÚrbz
failed: %sT)rw )r r© rr ÚENV_PICKLE_FILENAMEÚosr r r Z
find_filesr r r, r% ÚopenÚpickleÚloadr Ú Exceptionr r r )r rw ÚfilenameÚfÚerrr r r r s
$zSphinx._init_env)Únamer} c C s | j j| | d S )N)r
r )r r¶ r r r r . s zSphinx.preload_builderr8 c C s( |d krt jtd d}| jj| |S )Nz(No builder selected, using default: htmlÚhtml)r r r% r
r )r r¶ r r r r 1 s zSphinx.create_builderc C s( | j j| j | j j | jjd d S )Nzbuilder-inited)r Zset_environmentr r¥ r r )r r r r r 8 s
zSphinx._init_builder)Ú force_allÚ filenamesr} c C s´ t j| _y4|r&| jj | jj n2|rD| jj| | jj| n| jj | jj | j
rj| j rjd| _ | j dkr|t
dnt
d}| j
rä| jr®| j
dkr¤t
d}qÊt
d}n | j
dkrÂt
d}nt
d}tjt||| j
f ntjtt
d | | j dkr<| jjr<tjd
tj| jjt| j| jjd W nX tk
r } z:tj| jt}tj |rvt j | | j j d | W Y d d }~X nX | j j d d | jj! d S )
Né r Z succeededzfinished with problemsz7build %s, %s warning (with warnings treated as errors).z8build %s, %s warnings (with warnings treated as errors).zbuild %s, %s warning.zbuild %s, %s warnings.z build %s.Ú )rq r zbuild-finished)"r- ZREADINGr r Zcompile_all_catalogsZ build_allZcompile_specific_catalogsZbuild_specificZcompile_update_catalogsZ build_updater r| r r% rx r r r. Úepilogr3 rq r r r² r r© rr r Úisfiler® Úunlinkr r Úcleanup)r r¸ r¹ ru Úmsgrµ Zenvfiler r r Úbuild? sJ
z Sphinx.build)Úextnamer} c C s t jd| | jj| | dS )zâ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.
z [app] setting up extension: %rN)r Údebugr
Zload_extension)r r r r r r t s zSphinx.setup_extension)Úversionr} c C s |t jdd
krt|dS )a 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
Né )r r r! )r rÄ r r r Úrequire_sphinx~ s
zSphinx.require_sphinxéô )ÚeventÚcallbackÚpriorityr} c C s& | j j|||}tjd|||| |S )a? 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*
z*[app] connecting event %r (%d): %r [id=%s])r Úconnectr rà )r rÈ rÉ rÊ Ú listener_idr r r rË s zSphinx.connect)rÌ r} c C s t jd| | jj| dS )zvUnregister callback by *listener_id*.
:param listener_id: A listener_id that :meth:`connect` returns
z"[app] disconnecting event: [id=%s]N)r rà r Ú
disconnect)r rÌ r r r rÍ ¡ s zSphinx.disconnect)Úallowed_exceptions.)rÈ ÚargsrÎ r} c G s | j j|f|d|iS )að 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
rÎ )r r )r rÈ rÎ rÏ r r r r © s z Sphinx.emitc G s | j j|f|d|iS )aè 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
rÎ )r Úemit_firstresult)r rÈ rÎ rÏ r r r rÐ º s zSphinx.emit_firstresult)r Úoverrider} c C s | j j||d dS )a# Register a new builder.
:param builder: A builder class
:param override: If true, install the builder forcedly even if another builder
is already installed as the same name
.. versionchanged:: 1.8
Add *override* keyword.
)rÑ N)r
Ú add_builder)r r rÑ r r r rÒ Î s
zSphinx.add_builder)r¶ ÚdefaultÚrebuildÚtypesr} c C s> t jd||||f |dkr(|r$dnd}| jj|||| dS )ag 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.
z [app] adding config value: %rFTr r» N)FT)r rà r Úadd)r r¶ rÓ rÔ rÕ r r r Úadd_config_valueÛ s " zSphinx.add_config_valuec C s t jd| | jj| dS )zRegister an event called *name*.
This is needed to be able to emit it.
:param name: The name of the event
z[app] adding event: %rN)r rà r rÖ )r r¶ r r r Ú add_event s zSphinx.add_event)r¶ Útranslator_classrÑ r} c C s | j j|||d dS )a 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.
)rÑ N)r
Zadd_translator)r r¶ rÙ rÑ r r r Úset_translator s zSphinx.set_translator)ÚnoderÑ Úkwargsr} c K sV t jd||f | r8tj|r8t jtd|jddd tj| | jj |f| dS )aÐ 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.
z[app] adding node: %rzDnode class %r is already registered, its visitors will be overriddenÚappÚadd_node)ÚtypeÚsubtypeN)
r rà r* Zis_node_registeredrv r% Ú__name__Z
register_noder
Zadd_translation_handlers)r rÛ rÑ rÜ r r r rÞ s $
zSphinx.add_node)rÛ ÚfigtypeÚ title_getterrÑ rÜ r} c K s. | j j||||d | j|fd|i| dS )a_ 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
)rÑ rÑ N)r
Úadd_enumerable_noderÞ )r rÛ râ rã rÑ rÜ r r r rä K s zSphinx.add_enumerable_node)r¶ ÚclsrÑ r} c C sF t jd||f | r6tj|r6t jtd|ddd tj|| dS )a^ Register a Docutils directive.
:param name: The name of the directive
:param cls: A directive class
:param override: If true, install the directive forcedly even if another directive
is already installed as the same name
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.
z[app] adding directive: %rz9directive %r is already registered, it will be overriddenrÝ Ú
add_directive)rß rà N)r rà r* Zis_directive_registeredrv r% Zregister_directive)r r¶ rå rÑ r r r ræ h s
)
zSphinx.add_directive)r¶ ÚrolerÑ r} c C sF t jd||f | r6tj|r6t jtd|ddd tj|| dS )aÒ Register a Docutils role.
:param name: The name of role
:param role: A role function
:param override: If true, install the role forcedly even if another role is already
installed as the same name
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.
z[app] adding role: %rz4role %r is already registered, it will be overriddenrÝ Úadd_role)rß rà N)r rà r* Úis_role_registeredrv r% Ú
register_role)r r¶ rç rÑ r r r rè s
zSphinx.add_role)r¶ Ú nodeclassrÑ r} c C sR t jd||f | r6tj|r6t jtd|ddd tj||}tj|| dS )a Register a generic Docutils role.
Register a Docutils role that does nothing but wrap its contents in the
node given by *nodeclass*.
If *override* is True, the given *nodeclass* is forcedly installed even if
a role named as *name* is already installed.
.. versionadded:: 0.6
.. versionchanged:: 1.8
Add *override* keyword.
z [app] adding generic role: %rz4role %r is already registered, it will be overriddenrÝ Úadd_generic_role)rß rà N) r rà r* ré rv r% r Z GenericRolerê )r r¶ rë rÑ rç r r r rì ¬ s
zSphinx.add_generic_role)r§ rÑ r} c C s | j j||d dS )a8 Register a domain.
:param domain: A domain class
:param override: If true, install the domain forcedly even if another domain
is already installed as the same name
.. versionadded:: 1.0
.. versionchanged:: 1.8
Add *override* keyword.
)rÑ N)r
Ú
add_domain)r r§ rÑ r r r rí Â s zSphinx.add_domain)r§ r¶ rå rÑ r} c C s | j j||||d dS )a 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 true, install the directive forcedly even if another directive
is already installed as the same name
.. versionadded:: 1.0
.. versionchanged:: 1.8
Add *override* keyword.
)rÑ N)r
Úadd_directive_to_domain)r r§ r¶ rå rÑ r r r rî Ï s z Sphinx.add_directive_to_domain)r§ r¶ rç rÑ r} c C s | j j||||d dS )a 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 true, install the role forcedly even if another role is already
installed as the same name
.. versionadded:: 1.0
.. versionchanged:: 1.8
Add *override* keyword.
)rÑ N)r
Úadd_role_to_domain)r r§ r¶ rç rÑ r r r rï â s zSphinx.add_role_to_domain)r§ ÚindexrÑ r} c C s | j j|| dS )aÀ 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 true, install the index forcedly even if another index is
already installed as the same name
.. versionadded:: 1.0
.. versionchanged:: 1.8
Add *override* keyword.
N)r
Úadd_index_to_domain)r r§ rð rÑ r r r rñ õ s zSphinx.add_index_to_domainr» ) Ú
directivenameÚrolenameÚ
indextemplateÚ
parse_nodeÚ
ref_nodeclassÚobjnameÚdoc_field_typesrÑ r} c
C s | j j||||||||d dS )aX
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.
)rÑ N)r
Úadd_object_type) r rò ró rô rõ rö r÷ rø rÑ r r r rù s ?zSphinx.add_object_type)rò ró rô rö r÷ rÑ r} c C s | j j||||||d dS )a 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.)
If *override* is True, the given crossref_type is forcedly installed even if
a crossref_type having the same name is already installed.
.. versionchanged:: 1.8
Add *override* keyword.
)rÑ N)r
Úadd_crossref_type)r rò ró rô rö r÷ rÑ r r r rú I s #
zSphinx.add_crossref_type)Ú transformr} c C s | j j| dS )a= 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
N)r
Ú
add_transform)r rû r r r rü p s !zSphinx.add_transformc C s | j j| dS )a Register a Docutils transform to be applied before writing.
Add the standard docutils :class:`Transform` subclass *transform* to
the list of transforms that are applied before Sphinx writes a
document.
:param transform: A transform class
N)r
Úadd_post_transform)r rû r r r rý s zSphinx.add_post_transform)r³ rÊ Úloading_methodrÜ r} c K sb |dkrd|d< n|dkr"d|d< | j j|fd|i| t| jdr^| jj|fd|i| dS )aé Register a JavaScript file to include in the HTML output.
:param filename: The filename of the JavaScript file. It must be relative to the HTML
static path, a full URI with scheme, or ``None`` value. The ``None``
value is used to create inline ``<script>`` tag. See the description
of *kwargs* below.
:param priority: The priority to determine the order of ``<script>`` tag for
JavaScript files. See list of "prority range for JavaScript
files" below. If the priority of the JavaScript files it the same
as others, the JavaScript files will be loaded in order of
registration.
:param loading_method: The loading method of the JavaScript file. ``'async'`` or
``'defer'`` is allowed.
:param kwargs: Extra keyword arguments are included as attributes of the ``<script>``
tag. A special keyword argument ``body`` is given, its value will be
added between 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.
ÚasyncÚdeferrÊ Ú add_js_fileN)r
r Úhasattrr )r r³ rÊ rþ rÜ r r r r s 9
zSphinx.add_js_file)r³ rÊ rÜ r} c K sL t jd| | jj|fd|i| t| jdrH| jj|fd|i| dS )a[ Register a stylesheet to include in the HTML output.
:param filename: The filename of the CSS file. It must be relative to the HTML
static path, or a full URI with scheme.
:param priority: The priority to determine the order of ``<link>`` tag for the
CSS files. See list of "prority range for CSS files" below.
If the priority of the CSS files it the same as others, the
CSS files will be loaded in order of registration.
: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.
z[app] adding stylesheet: %rrÊ Ú add_css_fileN)r rà r
Z
add_css_filesr r r )r r³ rÊ rÜ r r r r à s 8 zSphinx.add_css_file)r³ Ú alternateÚtitler} c C sB t jd i }|r d|d< nd|d< |r0||d< | j|f| dS )zGAn alias of :meth:`add_css_file`.
.. deprecated:: 1.8
zNThe app.add_stylesheet() is deprecated. Please use app.add_css_file() instead.zalternate stylesheetÚrelZ
stylesheetr N)r rv r )r r³ r r Ú
attributesr r r Úadd_stylesheet s
zSphinx.add_stylesheet)Ú packagenameÚoptionsÚafter_hyperrefr} c C s | j j||| dS )a 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.
N)r
Úadd_latex_package)r r r
r r r r r 1 s zSphinx.add_latex_package)ÚaliasÚlexerr} c C s t jd||f |t|< dS )a2 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.
z[app] adding lexer: %rN)r rà r$ )r r
r r r r Ú add_lexerH s
zSphinx.add_lexer)rå rÑ r} c C sB t jd| ddlm} | jj|j| | jd|j ||d dS )a¨ 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.
z [app] adding autodocumenter: %rr )ÚAutodocDirectiveÚauto)rÑ N)r rà Z sphinx.ext.autodoc.directiver r
Zadd_documenterZobjtyperæ )r rå rÑ r r r r Úadd_autodocumenterU s zSphinx.add_autodocumenter)ÚtypÚgetterr} c C s" t jd||f | jj|| dS )a¼ 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
z#[app] adding autodoc attrgetter: %rN)r rà r
Úadd_autodoc_attrgetter)r r r r r r r l s z Sphinx.add_autodoc_attrgetter)rå r} c C s8 t jd| ddlm}m} t||s*t|||j< dS )a 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
z [app] adding search language: %rr )ÚSearchLanguageÚ languagesN)r rà Z
sphinx.searchr r Ú
issubclassÚAssertionErrorÚlang)r rå r r r r r Úadd_search_language{ s zSphinx.add_search_language)ÚsuffixÚfiletyperÑ r} c C s | j j|||d dS )a3 Register a suffix of source files.
Same as :confval:`source_suffix`. The users can override this
using the config setting.
If *override* is True, the given *suffix* is forcedly installed even if
the same suffix is already installed.
.. versionadded:: 1.8
)rÑ N)r
Úadd_source_suffix)r r r rÑ r r r r s zSphinx.add_source_suffix)ÚparserrÑ r} c C s | j j||d dS )aÈ Register a parser class.
If *override* is True, the given *parser* is forcedly installed even if
a parser for the same suffix is already installed.
.. 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.
)rÑ N)r
Úadd_source_parser)r r rÑ r r r r s
zSphinx.add_source_parser)Ú collectorr} c C s t jd| | j| dS )zxRegister an environment collector class.
Refer to :ref:`collector-api`.
.. versionadded:: 1.6
z&[app] adding environment collector: %rN)r rà Úenable)r r! r r r Úadd_env_collector§ s zSphinx.add_env_collector)r¶ Ú
theme_pathr} c C s t jd|| | jj|| dS )zÁRegister a HTML Theme.
The *name* is a name of theme, and *theme_path* is a full path to the
theme (refs: :ref:`distribute-your-theme`).
.. versionadded:: 1.6
z [app] adding HTML theme: %r, %rN)r rà r
Úadd_html_theme)r r¶ r$ r r r r% ± s zSphinx.add_html_theme)r¶ Úinline_renderersÚblock_renderersr} c C s | j j||| dS )a¦ 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
N)r
Úadd_html_math_renderer)r r¶ r& r' r r r r( ¼ s z Sphinx.add_html_math_renderer)r« Ú
locale_dirr} c C s$ t j|g| jj| t j|| dS )züRegister a message catalog.
:param catalog: The name of the catalog
:param locale_dir: The base path of the message catalog
For more details, see :func:`sphinx.locale.get_translation()`.
.. versionadded:: 1.8
N)r r¥ r r¤ Z init_console)r r« r) r r r Úadd_message_catalogÌ s
zSphinx.add_message_catalog)r r} c C s¼ |dkr d}t d}t d}n*|dkr<d}t d}t d}n td | xn| jj D ]`}t||d
}|d
krtj||j tjt d | d S |sTtj||j tjt d | d S qTW d
S )zCheck whether parallel processing is allowed or not.
:param typ: A type of processing; ``'read'`` or ``'write'``.
r Zparallel_read_safezthe %s extension does not declare if it is safe for parallel reading, assuming it isn't - please ask the extension author to check and make it explicitz1the %s extension is not safe for parallel readingÚwriteZparallel_write_safezthe %s extension does not declare if it is safe for parallel writing, assuming it isn't - please ask the extension author to check and make it explicitz1the %s extension is not safe for parallel writingz!parallel type %s is not supportedNzdoing serial %sFT)r% Ú
ValueErrorr ÚvaluesÚgetattrr rv r¶ )r r ÚattrnameZmessage_not_declaredZmessage_not_safeÚextÚallowedr r r Úis_parallel_allowedÚ s(
zSphinx.is_parallel_allowedc C s |dkrt d| || j_dS )zÖ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
ÚalwaysÚper_pagezpolicy %s is not supportedN)r3 r4 )r, r
Zhtml_assets_policy)r Úpolicyr r r Úset_html_assets_policyý s z Sphinx.set_html_assets_policyc C s t jdt | jjS )Nz app.html_themes is deprecated.)ÚwarningsÚwarnr r
Ú html_themes)r r r r r9 s zSphinx.html_themes)FN)rÇ )F)F)F)NF)F)F)F)F)F)F)F)r» Nr» F)rÇ N)rÇ )FN)NF)F)F)F)NN)Trá Ú
__module__Ú __qualname__Ú__doc__Úboolrx Úintr ÚsysÚstdoutÚstderrÚstrr r r r
r¡ r r r r r rÁ r rÆ r rË rÍ r r r
r² r rÐ rÒ r r× rØ r Ú NodeVisitorrÚ r rÞ r6 rä r ræ rè rì r rí rî r5 r( rï r rñ r rù rú r rü rý r r r r r r r r r r r r r r# r% r( r* r2 r6 Úpropertyr9 r r r r rn v s
:| 5
&&"&
,0 @ %# A=
&# rn c @ s\ e Zd ZdZddeee ddddZeddd Z ee
dd
d d Z ee
ed
d
dZ dS )ÚTemplateBridgez
This class defines the interface for a "template bridge", that is, a class
that renders templates given a template name and a context.
Nr8 )r ÚthemeÚdirsr} c C s t ddS )ab Called by the builder to initialize the template system.
*builder* is the builder object; you'll probably want to look at the
value of ``builder.config.templates_path``.
*theme* is a :class:`sphinx.theming.Theme` object or None; in the latter
case, *dirs* can be list of fixed directories to look for templates.
z!must be implemented in subclassesN)ÚNotImplementedError)r r rF rG r r r r¥ s zTemplateBridge.init)r} c C s dS )zàCalled by the builder to determine if output files are outdated
because of template changes. Return the mtime of the newest template
file that was changed. The default implementation returns ``0``.
r r )r r r r Únewest_template_mtime! s z$TemplateBridge.newest_template_mtime)ÚtemplateÚcontextr} c C s t ddS )zCalled by the builder to render a template given as a filename with
a specified context (a Python dictionary).
z!must be implemented in subclassesN)rH )r rJ rK r r r Úrender( s zTemplateBridge.renderc C s t ddS )z}Called by the builder to render a template given as a string with a
specified context (a Python dictionary).
z!must be implemented in subclassesN)rH )r rJ rK r r r Ú
render_string. s z TemplateBridge.render_string)NN)
rá r: r; r< r) r
rB r¥ ÚfloatrI r rL rM r r r r rE s
rE )5r9 r: r; r< r= r> r? r@ rA rB rC rD rE rF rG rH rI rJ rK rL rM rN rO rP rQ rR rS rT rU rV rW rX rY rZ r[ r\ r] r^ r_ r` ra rb rc rd re rf rg rh ri rj rk rl rm )cr< r® r° r? r7 Ú collectionsr Úior r Útypingr r r r r r
r r r
r r* r Zdocutils.nodesr r Zdocutils.parsersr Zdocutils.parsers.rstr r Zdocutils.transformsr Zpygments.lexerr r r r Z
sphinx.configr Zsphinx.deprecationr Zsphinx.domainsr r Zsphinx.environmentr Z sphinx.environment.collectorsr Z
sphinx.errorsr r r! Z
sphinx.eventsr" Zsphinx.extensionr# Zsphinx.highlightingr$ Z
sphinx.localer% Zsphinx.projectr& Zsphinx.registryr' Z sphinx.rolesr( Zsphinx.themingr) Z sphinx.utilr+ r, Zsphinx.util.build_phaser- Zsphinx.util.consoler. Zsphinx.util.i18nr/ Zsphinx.util.loggingr0 Zsphinx.util.osutilr1 r2 r3 Zsphinx.util.tagsr4 Zsphinx.util.typingr5 r6 r7 Zsphinx.buildersr8 r r Ú getLoggerrá r rn rE r r r r Ú<module> sÖ 0
#