diff options
author | Chris Sewell <chrisj_sewell@hotmail.com> | 2020-08-20 22:37:37 +0100 |
---|---|---|
committer | Chris Sewell <chrisj_sewell@hotmail.com> | 2020-08-20 22:37:37 +0100 |
commit | 5c744d834259d4144e779a79eaf0c9e312e75ed6 (patch) | |
tree | d5af122c75bcf7794a4685a547662f5c3c354a74 | |
parent | e4e9a0f4be3e9bdc82197c2fa577eec238032c39 (diff) | |
download | sphinx-git-5c744d834259d4144e779a79eaf0c9e312e75ed6.tar.gz |
📚 DOCS: Improve build process overview
-rw-r--r-- | doc/extdev/appapi.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/extdev/appapi.rst b/doc/extdev/appapi.rst index 036b57ec1..9a29aa77f 100644 --- a/doc/extdev/appapi.rst +++ b/doc/extdev/appapi.rst @@ -179,8 +179,10 @@ type for that event:: 11. event.env-get-updated(app, env) 11. 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: + for docname in updated-docs: 12. apply post-transforms (by priority): docutils.document -> docutils.document 13. event.doctree-resolved(app, doctree, docname) - (for any reference node that fails to resolve) event.missing-reference(env, node, contnode) |