summaryrefslogtreecommitdiff
path: root/doc/extdev/appapi.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/extdev/appapi.rst')
-rw-r--r--doc/extdev/appapi.rst15
1 files changed, 8 insertions, 7 deletions
diff --git a/doc/extdev/appapi.rst b/doc/extdev/appapi.rst
index 036b57ec1..df3eb3d67 100644
--- a/doc/extdev/appapi.rst
+++ b/doc/extdev/appapi.rst
@@ -177,17 +177,18 @@ type for that event::
9. (if running in parallel mode, for each process) event.env-merged-info(app, env, docnames, other)
10. event.env-updated(app, env)
11. event.env-get-updated(app, env)
- 11. event.env-check-consistency(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 docname in docnames:
- 12. apply post-transforms (by priority): docutils.document -> docutils.document
- 13. event.doctree-resolved(app, doctree, docname)
+ 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)
- 14. Generate output files
-
- 15. event.build-finished(app, exception)
+ 15. Generate output files
+ 16. event.build-finished(app, exception)
Here is a more detailed list of these events.