summaryrefslogtreecommitdiff
path: root/doc/extdev
diff options
context:
space:
mode:
authorTakeshi KOMIYA <i.tkomiya@gmail.com>2021-06-04 01:18:22 +0900
committerGitHub <noreply@github.com>2021-06-04 01:18:22 +0900
commit1418e3acbb8d89f2af812e93894b2cb7e9526f48 (patch)
tree34e8c7b7aaa5e35ab664a093fda0ba3f8df3b61f /doc/extdev
parent69cbf7aa92b2d30a1d865de7429f6388cb94b946 (diff)
parenta02f6c5e0cb9d68ad3cd9ef66f16c025947f608e (diff)
downloadsphinx-git-1418e3acbb8d89f2af812e93894b2cb7e9526f48.tar.gz
Merge pull request #9260 from tk0miya/9016_linkcheck_github_anchors
Close #9016: linkcheck builder failed to check the anchors of github.com
Diffstat (limited to 'doc/extdev')
-rw-r--r--doc/extdev/appapi.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/extdev/appapi.rst b/doc/extdev/appapi.rst
index 41318e9d6..ae81fc562 100644
--- a/doc/extdev/appapi.rst
+++ b/doc/extdev/appapi.rst
@@ -384,6 +384,14 @@ Here is a more detailed list of these events.
.. 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