\c.@sdZddlmZddlZddlZddlZddlmZddlm Z ddlm Z ddl m Z m Z mZddlmZdd lmZdd lmZddlZdd lmZmZdd lmZmZdd lmZddlmZmZmZddl m!Z!ddl"m#Z#m$Z$m%Z%ddl&m'Z'ddl(m)Z)ddl*m+Z+ddl,m-Z-ddl,m.Z.ddl,m/Z/ddl,m0Z0ddl1m2Z2ddl3m4Z4ddl5m6Z6ddl7m8Z8ddl9m:Z:m;Z;m<Z<ddl=m>Z>e?rddl@mAZAmBZBmCZCmDZDmEZEmFZFmGZGmHZHmIZImJZJddl-mKZKdd lLmMZMdd!lNmOZOdd"lPmQZQdd#lRmSZSmTZTdd$lUmVZVdd%lWmXZXdd&lYmZZZdd'l[m\Z\dd(l]m^Z^m_Z_nd)d*d+d,d-d.d/d0d1d2d3d4d5d6d7d8d9d:d;d<d=d>d?d@dAdBdCdDdEdFdGdHdIdJdKdLdMdNdOdPdQdRdSdTdUdVf.Z`dWZae/jbecZddXeefdYYZfdZeefd[YZgdS(\s sphinx.application ~~~~~~~~~~~~~~~~~~ Sphinx application class and extensibility interface. Gracefully adapted from the TextPress system by Armin. :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. i(tprint_functionN(tdeque(tisclass(tpath(t Directivet directivestroles(t itervalues(tcPickle(t cStringIO(t package_dirtlocale(tConfigt check_unicode(tCONFIG_FILENAME(tRemovedInSphinx20WarningtRemovedInSphinx30WarningtRemovedInSphinx40Warning(tBuildEnvironment(tApplicationErrort ConfigErrortVersionRequirementError(t EventManager(t__(tSphinxComponentRegistry(tdocutils(t import_object(tlogging(tpycompat(t BuildPhase(tbold(tdirective_helper(tfind_catalog_source_files(tabspatht ensuredirtrelpath(tTags( tAnytCallabletDicttIOtIterabletIteratortListtTupletTypetUnion(tnodes(tParser(t Transform(tBuilder(tDomaintIndex(tEnvironmentCollector(t Extension(tXRefRole(tTheme(t RoleFunctiont TitleGetterssphinx.builders.applehelpssphinx.builders.changesssphinx.builders.epub3ssphinx.builders.devhelpssphinx.builders.dummyssphinx.builders.gettextssphinx.builders.htmlssphinx.builders.htmlhelpssphinx.builders.latexssphinx.builders.linkcheckssphinx.builders.manpagessphinx.builders.qthelpssphinx.builders.texinfossphinx.builders.textssphinx.builders.websupportssphinx.builders.xmls sphinx.configssphinx.domains.cssphinx.domains.changesetssphinx.domains.cppssphinx.domains.javascriptssphinx.domains.mathssphinx.domains.pythonssphinx.domains.rstssphinx.domains.stdssphinx.directivesssphinx.directives.codessphinx.directives.otherssphinx.directives.patchesssphinx.extensions sphinx.iossphinx.parsersssphinx.registrys sphinx.roless!sphinx.transforms.post_transformss&sphinx.transforms.post_transforms.codes(sphinx.transforms.post_transforms.imagess(sphinx.transforms.post_transforms.compatssphinx.util.compats*sphinx.environment.collectors.dependenciess#sphinx.environment.collectors.assets&sphinx.environment.collectors.metadatas#sphinx.environment.collectors.titles%sphinx.environment.collectors.toctrees*sphinx.environment.collectors.indexentriest alabastersenvironment.pickletSphinxc BseZdZd:ejejeed:dded ZdZ dZ dZ dZ dZ ed:dZd:d:d:d Zd ed Zd Zd ZdZdZdZd:dZdZdZdZdZedZd;dZdZedZedZd:edZ e!dZ"d:d:edZ#edZ$edZ%ed Z&d!Z'd:d:ed"Z(ed#Z)ed$Z*d d:d:d ged%Z+d d:d:d gd&Z,d d:d ed'Z-d(Z.d)Z/d*Z0d+Z1d,Z2ed:d-Z3d:d.Z4d/Z5d0Z6d1Z7d2Z8ed3Z9d4Z:d5Z;d6Z<d:d:d7Z=d8Z>d9Z?RS(<sThe 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. icCsdtj|_| |_i|_dg|_d|_d|_t |_ i|_ t ||_ t ||_t ||_||_|jrt |j|_tjtj|jdsttd|qntj|j s ttd|j n|j |jkr1ttdn| |_|dkr^t|_t|_n||_t|_|dkrt|_n ||_d|_| o||_|jrt|_ n | |_ t!j"||j|jt#|_$t%dd|_&t'j(t)td t*j+d|_,t-| |_.|jdkrct/i|pWi|_0n1t/j1|j|pxi|j.|_0t2|j0|j0j3|j4|j0j5r|j0j5t*j+krt6td |j0j5n|jdkr |j |_nxt7D]}|j8|qWx!|j0jD]}|j8|q4W|j9|tj|st'j(td t:|n|j0j"rdg|_t;|j0j"r|j0j"|qt<td n|j0j=|j>d |j0|j0j?}|r7|j j@| r7t'jAtd|n|jB||_|jC| |jDdS(Nt?sconf.pys4config directory doesn't contain a conf.py file (%s)s!Cannot find source directory (%s)s>Source directory and destination directory cannot be identicalitmaxleni sRunning Sphinx v%ssWThis project needs at least Sphinx v%s and therefore cannot be built with this version.smaking output directory...s'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.s config-initeds%primary_domain %r not found, ignored.(ERtINITIALIZATIONtphaset verbosityt extensionst_setting_up_extensiontNonetbuildertenvRtregistryt html_themesR!tsrcdirtoutdirt doctreedirtconfdirRtisfiletjoinRRtisdirtparallelR t_statustTruetquiettFalset_warningt _warncountt keep_goingtwarningiserrorRtsetupRteventsRt messagelogtloggertinfoRtsphinxt__display_version__t statuscodeR$ttagsR tconfigtreadR tpre_init_valuest _init_i18nt needs_sphinxRtbuiltin_extensionstsetup_extensiontpreload_builderR"tcallableRt init_valuestemittprimary_domaint has_domaintwarningtcreate_buildert _init_envt _init_builder(tselfRIRLRJRKt buildernamet confoverrideststatusRotfreshenvRXRaRARPRWt extensionRm((s1lib/python2.7/site-packages/sphinx/application.pyt__init__s                           $   !         cCsQ|jjd k rtjttd|jjdtg|jjD]}t j |j |^qH}xEt ||jjddgd|jj D]}|j|jjqWd t j tdg|}ng}tj||jj\|_}|jjd k rM|s!|jjdkr7tjtdqMtjtd nd S( shLoad translated strings from the configured localedirs if enabled in the configuration. sloading translations [%s]... tnonltdomainsR^tcharsetR tentdones#not available for built-in messagesN(RbtlanguageRDR\R]RRRRt locale_dirsRRNRIR tsource_encodingtwrite_moR R tinitt translator(Rstxtuser_locale_dirstcatinfoRthas_translation((s1lib/python2.7/site-packages/sphinx/application.pyRe s".!cCstj|jt}|s.tjj| rft|_|jj||jj |j |j nypt j ttddtt|d)}tj||_|jj|WdQXt j tdWn9tk r}t j td||jdtnXdS(Nsloading pickled environment... RztrbR~s failed: %sRw(RRNRKtENV_PICKLE_FILENAMEtostexistsRRFRYt find_filesRbRER\R]RRRRtopentpickletloadt ExceptionRq(RsRwtfilenametfterr((s1lib/python2.7/site-packages/sphinx/application.pyRq#s cCs|jj||dS(N(RGRi(Rstname((s1lib/python2.7/site-packages/sphinx/application.pyRi5scCs;|dkr(tjtdd}n|jj||S(Ns(No builder selected, using default: htmlthtml(RDR\R]RRGRp(RsR((s1lib/python2.7/site-packages/sphinx/application.pyRp9s  cCs1|jj|j|jj|jddS(Nsbuilder-inited(REtset_environmentRFRRl(Rs((s1lib/python2.7/site-packages/sphinx/application.pyRrAs cCstj|_yf|r2|jj|jjnC|r[|jj||jj|n|jj|jj |j r|j rd|_ n|j dkrt dpt d}|j rtjtt dd|j ||j fntjtt d||j dkrq|jjrqtjdtj|jjit|jd 6|jjd 6nWnZtk r}tj|jt}tj|rtj|n|jd |nX|jd d|jj dS( Niit succeededsfinished with problemssbuild %s, %s warning.sbuild %s, %s warnings.s build %s.tRJtprojectsbuild-finished(!RtREADINGR@REtcompile_all_catalogst build_alltcompile_specific_catalogstbuild_specifictcompile_update_catalogst build_updateRVRWR`RR\R]RtepilogR#RJRbRRRRNRKRRMRtunlinkRlRDtcleanup(Rst force_allt filenamesRvRtenvfile((s1lib/python2.7/site-packages/sphinx/application.pytbuildIs@        cCs9tjdtddtj|d|d|d|dS(s}Emit a warning. If *location* is given, it should either be a tuple of (*docname*, *lineno*) or a string describing the location of the warning as well as possible. *type* and *subtype* are used to suppress warnings with :confval:`suppress_warnings`. .. deprecated:: 1.6 Use :mod:`sphinx.util.logging` instead. sAapp.warning() is now deprecated. Use sphinx.util.logging instead.t stacklevelittypetsubtypetlocationN(twarningstwarnRR\Ro(RstmessageRRR((s1lib/python2.7/site-packages/sphinx/application.pyRus  RcCs-tjdtddtj|d|dS(sEmit an informational message. If *nonl* is true, don't emit a newline at the end (which implies that more info output will follow soon.) .. deprecated:: 1.6 Use :mod:`sphinx.util.logging` instead. s>app.info() is now deprecated. Use sphinx.util.logging instead.RiRzN(RRRR\R](RsRRz((s1lib/python2.7/site-packages/sphinx/application.pyR]s  cOs-tjdtddtj|||dS(s~Emit a verbose informational message. .. deprecated:: 1.6 Use :mod:`sphinx.util.logging` instead. sAapp.verbose() is now deprecated. Use sphinx.util.logging instead.RiN(RRRR\tverbose(RsRtargstkwargs((s1lib/python2.7/site-packages/sphinx/application.pyRs  cOs-tjdtddtj|||dS(sEmit a debug-level informational message. .. deprecated:: 1.6 Use :mod:`sphinx.util.logging` instead. s?app.debug() is now deprecated. Use sphinx.util.logging instead.RiN(RRRR\tdebug(RsRRR((s1lib/python2.7/site-packages/sphinx/application.pyRs  cOs-tjdtddtj|||dS(sEmit a lowlevel debug-level informational message. .. deprecated:: 1.6 Use :mod:`sphinx.util.logging` instead. s4app.debug2() is now deprecated. Use debug() instead.RiN(RRRR\R(RsRRR((s1lib/python2.7/site-packages/sphinx/application.pytdebug2s  cCs'tjd||jj||dS(sImport 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. s[app] setting up extension: %rN(R\RRGtload_extension(Rstextname((s1lib/python2.7/site-packages/sphinx/application.pyRhscCs&|tjd kr"t|ndS(s Check the Sphinx version if requested. Compare *version* (which must be a ``major.minor`` version string, e.g. ``'1.1'``) with the version of the running Sphinx, and abort the build when it is too old. .. versionadded:: 1.0 iN(R^R_R(Rstversion((s1lib/python2.7/site-packages/sphinx/application.pytrequire_sphinxs cCs&tjdtddt|ddS(sImport an object from a ``module.name`` string. .. deprecated:: 1.8 Use ``sphinx.util.import_object()`` instead. sMapp.import_object() is deprecated. Use sphinx.util.add_object_type() instead.RitsourceN(RRRRRD(RstobjnameR((s1lib/python2.7/site-packages/sphinx/application.pyRs  cCs/|jj||}tjd||||S(s&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`. The method returns a "listener ID" that can be used as an argument to :meth:`disconnect`. s%[app] connecting event %r: %r [id=%s](RZtconnectR\R(Rsteventtcallbackt listener_id((s1lib/python2.7/site-packages/sphinx/application.pyRs cCs$tjd||jj|dS(s%Unregister callback by *listener_id*.s"[app] disconnecting event: [id=%s]N(R\RRZt disconnect(RsR((s1lib/python2.7/site-packages/sphinx/application.pyRscGsKy!tjd|t|d Wntk r4nX|jj|||S(sEmit *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! s[app] emitting event: %r%sid(R\RtreprRRZRl(RsRR((s1lib/python2.7/site-packages/sphinx/application.pyRls ! cGs|jj|||S(sEmit *event* and pass *arguments* to the callback functions. Return the result of the first callback that doesn't return ``None``. .. versionadded:: 0.5 (RZtemit_firstresult(RsRR((s1lib/python2.7/site-packages/sphinx/application.pyRscCs|jj|d|dS(sRegister a new builder. *builder* must be a class that inherits from :class:`~sphinx.builders.Builder`. .. versionchanged:: 1.8 Add *override* keyword. toverrideN(RGt add_builder(RsRER((s1lib/python2.7/site-packages/sphinx/application.pyR s cCsptjd|||f|r$|fnd|ttfkrS|rJdpMd}n|jj||||dS(sRegister a configuration value. This is necessary for Sphinx to recognize new values and set default values accordingly. The *name* should be prefixed with the extension name, to avoid clashes. The *default* value can be any Python object. The string value *rebuild* 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. .. versionchanged:: 0.6 Changed *rebuild* from a simple boolean (equivalent to ``''`` or ``'env'``) to a string. However, booleans are still accepted and converted internally. .. 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. s[app] adding config value: %rRFRN((R\RRTRRRbtadd(RsRtdefaulttrebuildttypes((s1lib/python2.7/site-packages/sphinx/application.pytadd_config_values  #cCs$tjd||jj|dS(sXRegister an event called *name*. This is needed to be able to emit it. s[app] adding event: %rN(R\RRZR(RsR((s1lib/python2.7/site-packages/sphinx/application.pyt add_event:scCs|jj||d|dS(sRegister 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 custom translator and define custom nodes for the translator (see :meth:`add_node`). .. versionadded:: 1.3 .. versionchanged:: 1.8 Add *override* keyword. RN(RGtadd_translator(RsRttranslator_classR((s1lib/python2.7/site-packages/sphinx/application.pytset_translatorCs cKstjd||f| r^tj|r^tjtd|jd|jddddntj||j j ||dS( sRegister 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. 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('') 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. s[app] adding node: %rscwhile setting up extension %s: node class %r is already registered, its visitors will be overriddeniRtappRtadd_nodeN( R\RRtis_node_registeredRoRRCt__name__t register_nodeRGtadd_translation_handlers(RstnodeRtkwds((s1lib/python2.7/site-packages/sphinx/application.pyRQs cKs6|jj|||d||j|d||dS(sRegister a Docutils node class as a numfig target. Sphinx numbers the node automatically. And then the users can refer it using :rst:role:`numref`. *figtype* is a type of enumerable nodes. Each figtypes have individual numbering sequences. As a system figtypes, ``figure``, ``table`` and ``code-block`` are defined. It is able to add custom nodes to these default figtypes. It is also able to define new custom figtype if new figtype is given. *title_getter* is 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. Other keyword arguments are used for node visitor functions. See the :meth:`.Sphinx.add_node` for details. .. versionadded:: 1.4 RN(RGtadd_enumerable_nodeR(RsRtfigtypet title_getterRR((s1lib/python2.7/site-packages/sphinx/application.pyRyscCs tjdtdd|jjS(NsYapp.enumerable_nodes() is deprecated. Use app.get_domain("std").enumerable_nodes instead.Ri(RRRRGtenumerable_nodes(Rs((s1lib/python2.7/site-packages/sphinx/application.pyRs  cKstjd|||||f|tjkrd| rdtjtd|jd|ddddnt| st|t  rt ||||}tj ||ntj ||dS( sRegister a Docutils directive. *name* must be the prospective directive name. There are two possible ways to write a directive: - In the docutils 0.4 style, *obj* is the directive function. *content*, *arguments* and *options* are set as attributes on the function and determine whether the directive has content, arguments and options, respectively. **This style is deprecated.** - In the docutils 0.5 style, *obj* is the directive class. It must already have attributes named *has_content*, *required_arguments*, *optional_arguments*, *final_argument_whitespace* and *option_spec* that correspond to the options for the function way. See `the Docutils docs `_ for details. The directive class must inherit from the class ``docutils.parsers.rst.Directive``. For example, the (already existing) :rst:dir:`literalinclude` directive would be added like this: .. code-block:: python from docutils.parsers.rst import Directive, directives class LiteralIncludeDirective(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): ... add_directive('literalinclude', LiteralIncludeDirective) .. 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. s[app] adding directive: %rsXwhile setting up extension %s: directive %r is already registered, it will be overriddeniRRRt add_directiveN( R\RRt _directivesRoRRCRt issubclassRRtregister_directive(RsRtobjtcontentt argumentsRtoptionst directive((s1lib/python2.7/site-packages/sphinx/application.pyRs4 cCsotjd||f|tjkr[| r[tjtd|jd|ddddntj||dS( sRRegister a Docutils role. *name* must be the role name that occurs in the source, *role* the role function. Refer to the `Docutils documentation `_ for more information. .. versionchanged:: 1.8 Add *override* keyword. s[app] adding role: %rsSwhile setting up extension %s: role %r is already registered, it will be overriddeniRRRtadd_roleN(R\RRt_rolesRoRRCtregister_local_role(RsRtroleR((s1lib/python2.7/site-packages/sphinx/application.pyRs cCstjd||f|tjkr[| r[tjtd|jd|ddddntj||}tj||dS( sRegister a generic Docutils role. Register a Docutils role that does nothing but wrap its contents in the node given by *nodeclass*. .. versionadded:: 0.6 .. versionchanged:: 1.8 Add *override* keyword. s[app] adding generic role: %rsSwhile setting up extension %s: role %r is already registered, it will be overriddeniRRRtadd_generic_roleN( R\RRRRoRRCt GenericRoleR(RsRt nodeclassRR((s1lib/python2.7/site-packages/sphinx/application.pyRs cCs|jj|d|dS(sRegister a domain. Make the given *domain* (which must be a class; more precisely, a subclass of :class:`~sphinx.domains.Domain`) known to Sphinx. .. versionadded:: 1.0 .. versionchanged:: 1.8 Add *override* keyword. RN(RGt add_domain(RstdomainR((s1lib/python2.7/site-packages/sphinx/application.pyR s cCs0tjdtdd|jj|dtdS(sJOverride a registered domain. Make the given *domain* class known to Sphinx, assuming that there is already a domain with its ``.name``. The new domain must be a subclass of the existing one. .. versionadded:: 1.0 .. deprecated:: 1.8 Integrated to :meth:`add_domain`. sWapp.override_domain() is deprecated. Use app.add_domain() with override option instead.RiRN(RRRRGRRR(RsR((s1lib/python2.7/site-packages/sphinx/application.pytoverride_domains  c Ks)|jj|||||d||dS(sRegister a Docutils directive in a domain. Like :meth:`add_directive`, but the directive is added to the domain named *domain*. .. versionadded:: 1.0 .. versionchanged:: 1.8 Add *override* keyword. RN(RGtadd_directive_to_domain(RsRRRt has_contentt argument_specRt option_spec((s1lib/python2.7/site-packages/sphinx/application.pyR's  cCs |jj|||d|dS(sRegister a Docutils role in a domain. Like :meth:`add_role`, but the role is added to the domain named *domain*. .. versionadded:: 1.0 .. versionchanged:: 1.8 Add *override* keyword. RN(RGtadd_role_to_domain(RsRRRR((s1lib/python2.7/site-packages/sphinx/application.pyR7s cCs|jj||dS(sRegister a custom index for a domain. Add a custom *index* class to the domain named *domain*. *index* must be a subclass of :class:`~sphinx.domains.Index`. .. versionadded:: 1.0 .. versionchanged:: 1.8 Add *override* keyword. N(RGtadd_index_to_domain(RsRtindexR((s1lib/python2.7/site-packages/sphinx/application.pyRDs c Cs,|jj|||||||d|dS(s* 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`). This method is also available under the deprecated alias :meth:`add_description_unit`. .. versionchanged:: 1.8 Add *override* keyword. RN(RGtadd_object_type( Rst directivenametrolenamet indextemplatet parse_nodet ref_nodeclassRtdoc_field_typesR((s1lib/python2.7/site-packages/sphinx/application.pyRQs? cCs9tjdtdd|j|||||||dS(sDeprecated alias for :meth:`add_object_type`. .. deprecated:: 1.6 Use :meth:`add_object_type` instead. sPapp.add_description_unit() is now deprecated. Use app.add_object_type() instead.RiN(RRRR(RsRRRRRRR((s1lib/python2.7/site-packages/sphinx/application.pytadd_description_units  cCs&|jj|||||d|dS(sRegister 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 `. (Of course, the element following the ``topic`` directive needn't be a section.) .. versionchanged:: 1.8 Add *override* keyword. RN(RGtadd_crossref_type(RsRRRRRR((s1lib/python2.7/site-packages/sphinx/application.pyRs  cCs|jj|dS(sRegister 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. .. 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`__ __ http://docutils.sourceforge.net/docs/ref/transforms.html#transform-priority-range-categories N(RGt add_transform(Rst transform((s1lib/python2.7/site-packages/sphinx/application.pyRs cCs|jj|dS(sRegister 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. N(RGtadd_post_transform(RsR((s1lib/python2.7/site-packages/sphinx/application.pyRscKs*tjdtdd|j||dS(s An alias of :meth:`add_js_file`.sMThe app.add_javascript() is deprecated. Please use app.add_js_file() instead.RiN(RRRt add_js_file(RsRR((s1lib/python2.7/site-packages/sphinx/application.pytadd_javascripts  cKs?|jj||t|jdr;|jj||ndS(sRegister a JavaScript file to include in the HTML output. Add *filename* to the list of JavaScript files that the default HTML template will include. The filename must be relative to the HTML static path , or a full URI with scheme. The keyword arguments are also accepted for attributes of `` app.add_js_file('example.js', async="async") # => .. versionadded:: 0.5 .. versionchanged:: 1.8 Renamed from ``app.add_javascript()``. And it allows keyword arguments as attributes of script tag. RN(RGRthasattrRE(RsRR((s1lib/python2.7/site-packages/sphinx/application.pyRscKsOtjd||jj||t|jdrK|jj||ndS(sRegister a stylesheet to include in the HTML output. Add *filename* to the list of CSS files that the default HTML template will include. The filename must be relative to the HTML static path, or a full URI with scheme. The keyword arguments are also accepted for attributes of ```` tag. Example:: app.add_css_file('custom.css') # => app.add_css_file('print.css', media='print') # => app.add_css_file('fancy.css', rel='alternate stylesheet', title='fancy') # => .. versionadded:: 1.0 .. versionchanged:: 1.6 Optional ``alternate`` and/or ``title`` attributes can be supplied with the *alternate* (of boolean type) and *title* (a string) arguments. The default is no title and *alternate* = ``False``. For more information, refer to the `documentation `__. .. versionchanged:: 1.8 Renamed from ``app.add_stylesheet()``. And it allows keyword arguments as attributes of link tag. spp] adding stylesheet: %rt add_css_fileN(R\RRGt add_css_filesRRER(RsRR((s1lib/python2.7/site-packages/sphinx/application.pyRs#cCs`tjdtddi}|r/d|ds     cCs|jj||dS(sRegister 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 `\usepackage` declaration. .. code-block:: python app.add_latex_package('mypackage') # => \usepackage{mypackage} app.add_latex_package('mypackage', 'foo,bar') # => \usepackage[foo,bar]{mypackage} .. versionadded:: 1.3 N(RGtadd_latex_package(Rst packagenameR((s1lib/python2.7/site-packages/sphinx/application.pyR PscCsDtjd||fddlm}|dkr6dS||| s    F