mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Change priority of doctree-read event
This commit is contained in:
parent
5e4da90ffa
commit
538c061e7c
3
CHANGES
3
CHANGES
@ -17,7 +17,8 @@ Incompatible changes
|
|||||||
a ``conf.py`` file sphinx-build generates.
|
a ``conf.py`` file sphinx-build generates.
|
||||||
* The ``gettext_compact`` attribute is removed from ``document.settings``
|
* The ``gettext_compact`` attribute is removed from ``document.settings``
|
||||||
object. Please use ``config.gettext_compact`` instead.
|
object. Please use ``config.gettext_compact`` instead.
|
||||||
* The processing order of smart_quotes and sphinx domains are changed. For more
|
* The processing order on reading phase is changed. smart_quotes, sphinx
|
||||||
|
domains and :event:`doctree-read` event are invoked earlier. For more
|
||||||
details, please read a description of :py:meth:`.Sphinx.add_transform()`
|
details, please read a description of :py:meth:`.Sphinx.add_transform()`
|
||||||
|
|
||||||
Deprecated
|
Deprecated
|
||||||
|
@ -570,10 +570,6 @@ class BuildEnvironment(object):
|
|||||||
with sphinx_domains(self), rst.default_role(docname, self.config.default_role):
|
with sphinx_domains(self), rst.default_role(docname, self.config.default_role):
|
||||||
doctree = read_doc(self.app, self, self.doc2path(docname))
|
doctree = read_doc(self.app, self, self.doc2path(docname))
|
||||||
|
|
||||||
# allow extension-specific post-processing
|
|
||||||
if app:
|
|
||||||
app.emit('doctree-read', doctree)
|
|
||||||
|
|
||||||
# store time of reading, for outdated files detection
|
# store time of reading, for outdated files detection
|
||||||
# (Some filesystems have coarse timestamp resolution;
|
# (Some filesystems have coarse timestamp resolution;
|
||||||
# therefore time.time() can be older than filesystem's timestamp.
|
# therefore time.time() can be older than filesystem's timestamp.
|
||||||
|
@ -24,7 +24,7 @@ from sphinx.transforms import (
|
|||||||
ApplySourceWorkaround, ExtraTranslatableNodes, CitationReferences,
|
ApplySourceWorkaround, ExtraTranslatableNodes, CitationReferences,
|
||||||
DefaultSubstitutions, MoveModuleTargets, HandleCodeBlocks, SortIds,
|
DefaultSubstitutions, MoveModuleTargets, HandleCodeBlocks, SortIds,
|
||||||
AutoNumbering, AutoIndexUpgrader, FilterSystemMessages,
|
AutoNumbering, AutoIndexUpgrader, FilterSystemMessages,
|
||||||
UnreferencedFootnotesDetector, SphinxSmartQuotes, ManpageLink
|
UnreferencedFootnotesDetector, SphinxSmartQuotes, DoctreeReadEvent, ManpageLink
|
||||||
)
|
)
|
||||||
from sphinx.transforms import SphinxTransformer
|
from sphinx.transforms import SphinxTransformer
|
||||||
from sphinx.transforms.compact_bullet_list import RefOnlyBulletListTransform
|
from sphinx.transforms.compact_bullet_list import RefOnlyBulletListTransform
|
||||||
@ -95,7 +95,7 @@ class SphinxStandaloneReader(SphinxBaseReader):
|
|||||||
HandleCodeBlocks, AutoNumbering, AutoIndexUpgrader, SortIds,
|
HandleCodeBlocks, AutoNumbering, AutoIndexUpgrader, SortIds,
|
||||||
RemoveTranslatableInline, FilterSystemMessages, RefOnlyBulletListTransform,
|
RemoveTranslatableInline, FilterSystemMessages, RefOnlyBulletListTransform,
|
||||||
UnreferencedFootnotesDetector, SphinxSmartQuotes, ManpageLink,
|
UnreferencedFootnotesDetector, SphinxSmartQuotes, ManpageLink,
|
||||||
SphinxDomains,
|
SphinxDomains, DoctreeReadEvent,
|
||||||
] # type: List[Transform]
|
] # type: List[Transform]
|
||||||
|
|
||||||
def __init__(self, app, *args, **kwargs):
|
def __init__(self, app, *args, **kwargs):
|
||||||
|
@ -399,6 +399,15 @@ class SphinxSmartQuotes(SmartQuotes, SphinxTransform):
|
|||||||
yield (texttype[notsmartquotable], txtnode.astext())
|
yield (texttype[notsmartquotable], txtnode.astext())
|
||||||
|
|
||||||
|
|
||||||
|
class DoctreeReadEvent(SphinxTransform):
|
||||||
|
"""Emit :event:`doctree-read` event."""
|
||||||
|
default_priority = 880
|
||||||
|
|
||||||
|
def apply(self):
|
||||||
|
# type: () -> None
|
||||||
|
self.app.emit('doctree-read', self.document)
|
||||||
|
|
||||||
|
|
||||||
class ManpageLink(SphinxTransform):
|
class ManpageLink(SphinxTransform):
|
||||||
"""Find manpage section numbers and names"""
|
"""Find manpage section numbers and names"""
|
||||||
default_priority = 999
|
default_priority = 999
|
||||||
|
Loading…
Reference in New Issue
Block a user