Skip to content

Commit cb4f206

Browse files
committed
Improve event listener names
1 parent e849ca0 commit cb4f206

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

src/sphinx_codeautolink/__init__.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ def setup(app: Sphinx):
2323
app.add_directive('implicit-import', ImplicitImport)
2424
app.add_directive('autolink-skip', AutoLinkSkip)
2525

26-
app.connect('builder-inited', state.builder_inited)
27-
app.connect('doctree-read', state.doctree_read)
28-
app.connect('doctree-resolved', state.doctree_resolved)
29-
app.connect('build-finished', state.build_finished)
26+
app.connect('builder-inited', state.read_references)
27+
app.connect('doctree-read', state.parse_blocks)
28+
app.connect('doctree-resolved', state.generate_backref_tables)
29+
app.connect('build-finished', state.apply_links)
3030
app.connect('autodoc-process-docstring', state.autodoc_process_docstring)
3131
return {'version': __version__}

src/sphinx_codeautolink/extension/__init__.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ def flat_refs(self):
3333

3434
return self._flat_refs
3535

36-
def builder_inited(self, app):
36+
def read_references(self, app):
3737
"""Nullify extension if not on HTML builder, read ref file."""
3838
if app.builder.name != 'html':
3939
self.do_nothing = True
@@ -55,7 +55,7 @@ def builder_inited(self, app):
5555
for obj, examples in ref.items()
5656
}
5757

58-
def doctree_read(self, app, doctree):
58+
def parse_blocks(self, app, doctree):
5959
"""Parse code blocks for later link substitution."""
6060
if self.do_nothing:
6161
return
@@ -69,16 +69,16 @@ def doctree_read(self, app, doctree):
6969
self.code_refs[visitor.current_document] = visitor.code_refs
7070
self.block_visitors.append(visitor)
7171

72-
def doctree_resolved(self, app, doctree, docname):
73-
"""Replace deferred code reference directives."""
72+
def generate_backref_tables(self, app, doctree, docname):
73+
"""Generate backreference tables."""
7474
visitor = CodeRefsVisitor(
7575
doctree,
7676
code_refs=self.flat_refs,
7777
remove_directives=self.do_nothing,
7878
)
7979
doctree.walk(visitor)
8080

81-
def build_finished(self, app, exception):
81+
def apply_links(self, app, exception):
8282
"""Apply links to HTML output and write refs file."""
8383
if self.do_nothing or exception is not None:
8484
return

0 commit comments

Comments
 (0)