DOC: Events overview #7904
DOC: Events overview #7904
Conversation
|
whoahh I see a ton of conflicting files here...perhaps I am making this PR against the wrong branch? |
doc/extdev/index.rst
Outdated
|
|
||
|
|
||
| Extension How-tos | ||
| ----------------- |
There was a problem hiding this comment.
Is this change intended? It seems not related to "events overview".
There was a problem hiding this comment.
nope, accident, I'll remove
|
It seems you added the changes into master branch. So I changed the target branch of this PR to master. |
doc/extdev/appapi.rst
Outdated
| 13. event.doctree-resolved(app, doctree, docname) | ||
| - (for any reference node that fails to resolve) event.missing-reference(env, node, contnode) | ||
|
|
||
| 14. call builder |
There was a problem hiding this comment.
The builder controls the whole of the build. It starts to work just after "2. builder-inited" event to before "15. build-finished". I thought "generate output files" is better than this.
|
oops! let me re-work this PR to be on 3.0 since that seems more appropriate |
|
OK I just started fresh from |
|
wohoo, thanks! |
This PR adds a short overview of the events emitted during the build process, to help extension developers understand when events happen in relation to one another, and the overall build process.
I tried to incorporate all of the feedback that @tk0miya gave, though likely this will need some more iteration. What do people think?
note: @tk0miya you mentioned an event "
get-env-updated" but I couldn't find it documented in https://www.sphinx-doc.org/en/master/extdev/appapi.htmlcloses #7215