summaryrefslogtreecommitdiff
path: root/doc/extdev
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2021-04-10 00:32:26 +0900
committerGitHub <noreply@github.com>2021-04-10 00:32:26 +0900
commitfe6d95e4294f47d61f1a04a1f8c6567c9802f504 (patch)
tree33a7143bf1dcf60830c2e1fcd4b396175af45e64 /doc/extdev
parent7327e56dff865d4766c43d46405ae827e10fd6c3 (diff)
parentce5d66e618c111b115a9bb7b1401a26483fcfa8f (diff)
downloadsphinx-git-fe6d95e4294f47d61f1a04a1f8c6567c9802f504.tar.gz
Merge branch 'master' into patch-1
Diffstat (limited to 'doc/extdev')
-rw-r--r--doc/extdev/appapi.rst23
-rw-r--r--doc/extdev/deprecated.rst65
-rw-r--r--doc/extdev/nodes.rst2
3 files changed, 81 insertions, 9 deletions
diff --git a/doc/extdev/appapi.rst b/doc/extdev/appapi.rst
index 4585df949..41318e9d6 100644
--- a/doc/extdev/appapi.rst
+++ b/doc/extdev/appapi.rst
@@ -167,26 +167,33 @@ type for that event::
4. event.env-before-read-docs(app, env, docnames)
for docname in docnames:
- 5. event.env-purge-doc(app, env, docname)
+ 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 (parsers can be added with the app.add_source_parser() API)
- 8. apply transforms (by priority): docutils.document -> docutils.document
- - event.doctree-read(app, doctree) is called in the middly of transforms,
+ 7. run source parsers: text -> docutils.document
+ - parsers can be added with the app.add_source_parser() API
+ 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. (if running in parallel mode, for each process) event.env-merged-info(app, env, docnames, other)
+
+ 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)
# The updated-docs list can be builder dependent, but generally includes all new/changed documents,
# plus any output from `env-get-updated`, and then all "parent" documents in the ToC tree
- # For builders that output a single page, they are first joined into a single doctree before post-transforms/doctree-resolved
+ # For builders that output a single page, they are first joined into a single doctree before post-transforms
+ # or the doctree-resolved event is emitted
for docname in updated-docs:
13. apply post-transforms (by priority): docutils.document -> docutils.document
14. event.doctree-resolved(app, doctree, docname)
- - (for any reference node that fails to resolve) event.missing-reference(env, node, contnode)
- - (for any reference node that fails to resolve) event.warn-missing-reference(domain, node)
+ - In the event that any reference nodes fail to resolve, the following may emit:
+ - event.missing-reference(env, node, contnode)
+ - event.warn-missing-reference(domain, node)
15. Generate output files
16. event.build-finished(app, exception)
diff --git a/doc/extdev/deprecated.rst b/doc/extdev/deprecated.rst
index ccf1e79da..9e17b9fb4 100644
--- a/doc/extdev/deprecated.rst
+++ b/doc/extdev/deprecated.rst
@@ -22,6 +22,71 @@ The following is a list of deprecated interfaces.
- (will be) Removed
- Alternatives
+ * - ``favicon`` variable in HTML templates
+ - 4.0
+ - TBD
+ - ``favicon_url``
+
+ * - ``logo`` variable in HTML templates
+ - 4.0
+ - TBD
+ - ``logo_url``
+
+ * - ``sphinx.directives.patches.ListTable``
+ - 4.0
+ - 6.0
+ - ``docutils.parsers.rst.diretives.tables.ListSVTable``
+
+ * - ``sphinx.directives.patches.RSTTable``
+ - 4.0
+ - 6.0
+ - ``docutils.parsers.rst.diretives.tables.RSTTable``
+
+ * - ``sphinx.ext.autodoc.directive.DocumenterBridge.filename_set``
+ - 4.0
+ - 6.0
+ - ``sphinx.ext.autodoc.directive.DocumenterBridge.record_dependencies``
+
+ * - ``sphinx.ext.autodoc.directive.DocumenterBridge.warn()``
+ - 4.0
+ - 6.0
+ - :ref:`logging-api`
+
+ * - ``sphinx.registry.SphinxComponentRegistry.get_source_input()``
+ - 4.0
+ - 6.0
+ - N/A
+
+ * - ``sphinx.registry.SphinxComponentRegistry.source_inputs``
+ - 4.0
+ - 6.0
+ - N/A
+
+ * - ``sphinx.transforms.FigureAligner``
+ - 4.0
+ - 6.0
+ - N/A
+
+ * - ``sphinx.util.pycompat.convert_with_2to3()``
+ - 4.0
+ - 6.0
+ - N/A
+
+ * - ``sphinx.util.pycompat.execfile_()``
+ - 4.0
+ - 6.0
+ - N/A
+
+ * - ``sphinx.util.smartypants``
+ - 4.0
+ - 6.0
+ - ``docutils.utils.smartyquotes``
+
+ * - ``sphinx.util.typing.DirectiveOption``
+ - 4.0
+ - 6.0
+ - N/A
+
* - pending_xref node for viewcode extension
- 3.5
- 5.0
diff --git a/doc/extdev/nodes.rst b/doc/extdev/nodes.rst
index 5d8272eae..3976de4c7 100644
--- a/doc/extdev/nodes.rst
+++ b/doc/extdev/nodes.rst
@@ -37,8 +37,8 @@ New inline nodes
.. autoclass:: index
.. autoclass:: pending_xref
+.. autoclass:: pending_xref_condition
.. autoclass:: literal_emphasis
-.. autoclass:: abbreviation
.. autoclass:: download_reference
Special nodes