diff options
| author | Takeshi KOMIYA <i.tkomiya@gmail.com> | 2021-06-06 13:33:17 +0900 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-06-06 13:33:17 +0900 |
| commit | b6245266ab9bddfb549c96eba63c196bf35ff0db (patch) | |
| tree | 8a1c2ddf456b353454a8c49f303394365e846fa8 /doc/extdev | |
| parent | a47a22de0f58cab2d5b9651167ad90a74e151dcc (diff) | |
| parent | e0500f7354989e5190ec874376535a1dfe65bab5 (diff) | |
| download | sphinx-git-b6245266ab9bddfb549c96eba63c196bf35ff0db.tar.gz | |
Merge pull request #9303 from tk0miya/fix_docslint
doc: Fix docslint misunderstanding scope of code-blocks
Diffstat (limited to 'doc/extdev')
| -rw-r--r-- | doc/extdev/appapi.rst | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/doc/extdev/appapi.rst b/doc/extdev/appapi.rst index ae81fc562..7c331382c 100644 --- a/doc/extdev/appapi.rst +++ b/doc/extdev/appapi.rst @@ -159,7 +159,9 @@ connect handlers to the events. Example: Below is an overview of each event that happens during a build. In the list below, we include the event name, its callback parameters, and the input and output -type for that event:: +type for that event: + +.. code-block:: none 1. event.config-inited(app,config) 2. event.builder-inited(app) @@ -168,7 +170,7 @@ type for that event:: for docname in docnames: 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 @@ -176,10 +178,10 @@ type for that event:: 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. event.env-merge-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) @@ -377,7 +379,8 @@ Here is a more detailed list of these events. ``'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. + :meth:`Sphinx.add_js_file` and :meth:`Sphinx.add_css_file` since + v3.5.0. .. versionadded:: 0.4 |