diff options
Diffstat (limited to 'doc/extdev')
| -rw-r--r-- | doc/extdev/appapi.rst | 21 | ||||
| -rw-r--r-- | doc/extdev/deprecated.rst | 15 | ||||
| -rw-r--r-- | doc/extdev/i18n.rst | 2 | ||||
| -rw-r--r-- | doc/extdev/index.rst | 6 | ||||
| -rw-r--r-- | doc/extdev/markupapi.rst | 2 | ||||
| -rw-r--r-- | doc/extdev/parserapi.rst | 2 |
6 files changed, 35 insertions, 13 deletions
diff --git a/doc/extdev/appapi.rst b/doc/extdev/appapi.rst index 41318e9d6..7c331382c 100644 --- a/doc/extdev/appapi.rst +++ b/doc/extdev/appapi.rst @@ -159,7 +159,9 @@ connect handlers to the events. Example: Below is an overview of each event that happens during a build. In the list below, we include the event name, its callback parameters, and the input and output -type for that event:: +type for that event: + +.. code-block:: none 1. event.config-inited(app,config) 2. event.builder-inited(app) @@ -168,7 +170,7 @@ type for that event:: for docname in docnames: 5. event.env-purge-doc(app, env, docname) - + if doc changed and not removed: 6. source-read(app, docname, source) 7. run source parsers: text -> docutils.document @@ -176,10 +178,10 @@ type for that event:: 8. apply transforms based on priority: docutils.document -> docutils.document - event.doctree-read(app, doctree) is called in the middle of transforms, transforms come before/after this event depending on their priority. - + 9. event.env-merge-info(app, env, docnames, other) - if running in parallel mode, this event will be emitted for each process - + 10. event.env-updated(app, env) 11. event.env-get-updated(app, env) 12. event.env-check-consistency(app, env) @@ -377,13 +379,22 @@ Here is a more detailed list of these events. ``'page.html'`` as the HTML template for this page. .. note:: You can install JS/CSS files for the specific page via - :meth:`Sphinx.add_js_file` and :meth:`Sphinx.add_css_file` since v3.5.0. + :meth:`Sphinx.add_js_file` and :meth:`Sphinx.add_css_file` since + v3.5.0. .. versionadded:: 0.4 .. versionchanged:: 1.3 The return value can now specify a template name. +.. event:: linkcheck-process-uri (app, uri) + + Emitted when the linkcheck builder collects hyperlinks from document. *uri* + is a collected URI. The event handlers can modify the URI by returning a + string. + + .. versionadded:: 4.1 + .. event:: build-finished (app, exception) Emitted when a build has finished, before Sphinx exits, usually used for diff --git a/doc/extdev/deprecated.rst b/doc/extdev/deprecated.rst index 79081828b..bca49370b 100644 --- a/doc/extdev/deprecated.rst +++ b/doc/extdev/deprecated.rst @@ -22,11 +22,21 @@ The following is a list of deprecated interfaces. - (will be) Removed - Alternatives + * - The optional argument ``app`` for ``sphinx.environment.BuildEnvironment`` + - 4.1 + - 6.0 + - The required argument + * - ``sphinx.application.Sphinx.html_theme`` - 4.1 - 6.0 - ``sphinx.registry.SphinxComponentRegistry.html_themes`` + * - ``sphinx.ext.autosummary._app`` + - 4.1 + - 6.0 + - N/A + * - ``sphinx.util.docstrings.extract_metadata()`` - 4.1 - 6.0 @@ -740,8 +750,9 @@ The following is a list of deprecated interfaces. * - ``sphinx.environment.NoUri`` - 2.1 - - 4.0 + - 3.0 - ``sphinx.errors.NoUri`` + * - ``sphinx.ext.apidoc.format_directive()`` - 2.1 - 4.0 @@ -1025,7 +1036,7 @@ The following is a list of deprecated interfaces. * - ``sphinx.util.force_decode()`` - 2.0 - - 4.0 + - 5.0 - N/A * - ``sphinx.util.get_matching_docs()`` diff --git a/doc/extdev/i18n.rst b/doc/extdev/i18n.rst index 75ef36cc5..6b32b8b73 100644 --- a/doc/extdev/i18n.rst +++ b/doc/extdev/i18n.rst @@ -94,4 +94,4 @@ message catalog template and message catalogs, for example via `Babel`_: $ pybabel extract --output=src/locale/myextension.pot src/ $ pybabel update --input-file=src/locale/myextension.pot --domain=myextension --output-dir=src/locale -.. _Babel: http://babel.pocoo.org/ +.. _Babel: https://babel.pocoo.org/ diff --git a/doc/extdev/index.rst b/doc/extdev/index.rst index d9c04f413..ffe8bc136 100644 --- a/doc/extdev/index.rst +++ b/doc/extdev/index.rst @@ -112,7 +112,7 @@ in which a Sphinx project is built: this works in several phases. existing files are read, temporary nodes are created. There are nodes provided by docutils, which are documented `in the docutils - documentation <http://docutils.sourceforge.net/docs/ref/doctree.html>`__. + documentation <https://docutils.sourceforge.io/docs/ref/doctree.html>`__. Additional nodes are provided by Sphinx and :ref:`documented here <nodes>`. During reading, the build environment is updated with all meta- and cross @@ -175,7 +175,7 @@ as metadata of the extension. Metadata keys currently recognized are: .. note:: The *parallel-read-safe* extension must satisfy the following conditions: - * The core logic of the extension is parallely executable during + * The core logic of the extension is parallelly executable during the reading phase. * It has event handlers for :event:`env-merge-info` and :event:`env-purge-doc` events if it stores dataa to the build @@ -188,7 +188,7 @@ as metadata of the extension. Metadata keys currently recognized are: .. note:: The *parallel-write-safe* extension must satisfy the following conditions: - * The core logic of the extension is parallely executable during + * The core logic of the extension is parallelly executable during the writing phase. diff --git a/doc/extdev/markupapi.rst b/doc/extdev/markupapi.rst index 7a21f8126..8fc884d7c 100644 --- a/doc/extdev/markupapi.rst +++ b/doc/extdev/markupapi.rst @@ -149,4 +149,4 @@ return ``node.children`` from the Directive. `Creating directives`_ HOWTO of the Docutils documentation -.. _Creating directives: http://docutils.sourceforge.net/docs/howto/rst-directives.html +.. _Creating directives: https://docutils.sourceforge.io/docs/howto/rst-directives.html diff --git a/doc/extdev/parserapi.rst b/doc/extdev/parserapi.rst index 0beb51711..1bd03fd09 100644 --- a/doc/extdev/parserapi.rst +++ b/doc/extdev/parserapi.rst @@ -8,7 +8,7 @@ Parser API The Parser analyzes the input document and creates a node tree representation. -__ http://docutils.sourceforge.net/docs/dev/hacking.html#parsing-the-document +__ https://docutils.sourceforge.io/docs/dev/hacking.html#parsing-the-document In Sphinx, the parser modules works as same as docutils. The parsers are registered to Sphinx by extensions using Application APIs; |