IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add env-read-docs event to allow modify docnames list before processing

Browse Source
This commit is contained in:
Guillem Barba 2014-07-31 18:28:47 +02:00
parent 6630255a10
commit b4b15181b4
3 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/extdev/appapi.rst
View File

@ -422,6 +422,14 @@ handlers to the events. Example:
.. versionadded:: 0.5 .. versionadded:: 0.5
.. event:: env-read-docs (app, env, docnames)
Emited after get the list of all added and changed files and just before
read them. It allow extension author modify docnames list before processing;
reordering, append and remove.
.. versionadded:: 1.3.0
.. event:: source-read (app, docname, source) .. event:: source-read (app, docname, source)
Emitted when a source file has been read. The *source* argument is a list Emitted when a source file has been read. The *source* argument is a list

1
sphinx/application.py
View File

@ -48,6 +48,7 @@ events = {
'builder-inited': '', 'builder-inited': '',
'env-get-outdated': 'env, added, changed, removed', 'env-get-outdated': 'env, added, changed, removed',
'env-purge-doc': 'env, docname', 'env-purge-doc': 'env, docname',
'env-read-docs': 'env, docnames',
'source-read': 'docname, source text', 'source-read': 'docname, source text',
'doctree-read': 'the doctree before being pickled', 'doctree-read': 'the doctree before being pickled',
'missing-reference': 'env, node, contnode', 'missing-reference': 'env, node, contnode',

9
sphinx/environment.py
View File

@ -469,7 +469,14 @@ class BuildEnvironment:
self.clear_doc(docname) self.clear_doc(docname)
# read all new and changed files # read all new and changed files
for docname in sorted(added | changed): docnames = sorted(added | changed)
if app:
new_docnames = []
for mod_docnames in app.emit('env-read-docs', self, docnames):
new_docnames.extend(mod_docnames)
if new_docnames:
docnames = new_docnames
for docname in docnames:
yield docname yield docname
self.read_doc(docname, app=app) self.read_doc(docname, app=app)