summaryrefslogtreecommitdiff
path: root/doc/extdev
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2021-01-23 20:44:13 +0900
committerTakeshi KOMIYA <i.tkomiya@gmail.com>2021-01-23 20:44:13 +0900
commitccf4ae37298d9088fa7bc1ad8d311be203aa795c (patch)
tree90e9dbc0f5eb01dc3415719e737597f44c68ad4d /doc/extdev
parent65a69965a1dba7e8f61caf53d3d8a9251eab4e19 (diff)
parent37fc43a4d389e173902207e753f4c9e28465e454 (diff)
downloadsphinx-git-ccf4ae37298d9088fa7bc1ad8d311be203aa795c.tar.gz
Merge branch 'master' into 8510_html_logo_url
Diffstat (limited to 'doc/extdev')
-rw-r--r--doc/extdev/appapi.rst26
-rw-r--r--doc/extdev/deprecated.rst106
-rw-r--r--doc/extdev/domainapi.rst15
-rw-r--r--doc/extdev/nodes.rst1
4 files changed, 138 insertions, 10 deletions
diff --git a/doc/extdev/appapi.rst b/doc/extdev/appapi.rst
index 9f2c10676..1a4c30d6d 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-merged-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)
@@ -369,6 +376,9 @@ Here is a more detailed list of these events.
You can return a string from the handler, it will then replace
``'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.
+
.. versionadded:: 0.4
.. versionchanged:: 1.3
diff --git a/doc/extdev/deprecated.rst b/doc/extdev/deprecated.rst
index 0101798bb..c7c18b803 100644
--- a/doc/extdev/deprecated.rst
+++ b/doc/extdev/deprecated.rst
@@ -36,11 +36,97 @@ The following is a list of deprecated interfaces.
- TBD
- ``logo_url``
+ * - ``sphinx.directives.patches.CSVTable``
+ - 4.0
+ - 6.0
+ - ``docutils.parsers.rst.diretives.tables.CSVTable``
+
+ * - ``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.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``
+
+ * - pending_xref node for viewcode extension
+ - 3.5
+ - 5.0
+ - ``sphinx.ext.viewcode.viewcode_anchor``
+
+ * - ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.broken``
+ - 3.5
+ - 5.0
+ - N/A
+
+ * - ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.good``
+ - 3.5
+ - 5.0
+ - N/A
+
+ * - ``sphinx.builders.linkcheck.CheckExternalLinksBuilder.redirected``
+ - 3.5
+ - 5.0
+ - N/A
+
+ * - ``sphinx.builders.linkcheck.node_line_or_0()``
+ - 3.5
+ - 5.0
+ - ``sphinx.util.nodes.get_node_line()``
+
+ * - ``sphinx.ext.autodoc.AttributeDocumenter.isinstanceattribute()``
+ - 3.5
+ - 5.0
+ - N/A
+
+ * - ``sphinx.ext.autodoc.importer.get_module_members()``
+ - 3.5
+ - 5.0
+ - ``sphinx.ext.autodoc.ModuleDocumenter.get_module_members()``
+
+ * - ``sphinx.ext.autosummary.generate._simple_info()``
+ - 3.5
+ - 5.0
+ - :ref:`logging-api`
+
+ * - ``sphinx.ext.autosummary.generate._simple_warn()``
+ - 3.5
+ - 5.0
+ - :ref:`logging-api`
+
* - The ``follow_wrapped`` argument of ``sphinx.util.inspect.signature()``
- 3.4
- 5.0
- N/A
+ * - The ``no_docstring`` argument of
+ ``sphinx.ext.autodoc.Documenter.add_content()``
+ - 3.4
+ - 5.0
+ - ``sphinx.ext.autodoc.Documenter.get_doc()``
+
* - ``sphinx.ext.autodoc.Documenter.get_object_members()``
- 3.4
- 6.0
@@ -51,6 +137,11 @@ The following is a list of deprecated interfaces.
- 5.0
- ``sphinx.ext.autodoc.DataDocumenter``
+ * - ``sphinx.ext.autodoc.GenericAliasDocumenter``
+ - 3.4
+ - 5.0
+ - ``sphinx.ext.autodoc.DataDocumenter``
+
* - ``sphinx.ext.autodoc.InstanceAttributeDocumenter``
- 3.4
- 5.0
@@ -66,16 +157,31 @@ The following is a list of deprecated interfaces.
- 5.0
- ``sphinx.ext.autodoc.DataDocumenter``
+ * - ``sphinx.ext.autodoc.directive.DocumenterBridge.reporter``
+ - 3.5
+ - 5.0
+ - ``sphinx.util.logging``
+
* - ``sphinx.ext.autodoc.importer._getannotations()``
- 3.4
- 4.0
- ``sphinx.util.inspect.getannotations()``
+ * - ``sphinx.ext.autodoc.importer._getmro()``
+ - 3.4
+ - 4.0
+ - ``sphinx.util.inspect.getmro()``
+
* - ``sphinx.pycode.ModuleAnalyzer.parse()``
- 3.4
- 5.0
- ``sphinx.pycode.ModuleAnalyzer.analyze()``
+ * - ``sphinx.util.osutil.movefile()``
+ - 3.4
+ - 5.0
+ - ``os.replace()``
+
* - ``sphinx.util.requests.is_ssl_error()``
- 3.4
- 5.0
diff --git a/doc/extdev/domainapi.rst b/doc/extdev/domainapi.rst
index d6ecf0633..674a3aa9a 100644
--- a/doc/extdev/domainapi.rst
+++ b/doc/extdev/domainapi.rst
@@ -1,7 +1,7 @@
.. _domain-api:
Domain API
-----------
+==========
.. module:: sphinx.domains
@@ -12,3 +12,16 @@ Domain API
.. autoclass:: Index
:members:
+
+
+Python Domain
+-------------
+
+.. module:: sphinx.domains.python
+
+.. autoclass:: PythonDomain
+
+ .. autoattribute:: objects
+ .. autoattribute:: modules
+ .. automethod:: note_object
+ .. automethod:: note_module
diff --git a/doc/extdev/nodes.rst b/doc/extdev/nodes.rst
index 5d8272eae..e38393a78 100644
--- a/doc/extdev/nodes.rst
+++ b/doc/extdev/nodes.rst
@@ -38,7 +38,6 @@ New inline nodes
.. autoclass:: index
.. autoclass:: pending_xref
.. autoclass:: literal_emphasis
-.. autoclass:: abbreviation
.. autoclass:: download_reference
Special nodes