Skip to content

Commit 3b0dab2

Browse files
committed
Remove Renderer.builder, pass builder as required
1 parent 0ca5b4b commit 3b0dab2

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

quartodoc/autosummary.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -507,7 +507,6 @@ def __init__(
507507
self.parser = parser
508508

509509
self.renderer = Renderer.from_config(renderer)
510-
self.renderer.builder = self
511510
if render_interlinks:
512511
# this is a top-level option, but lives on the renderer
513512
# so we just manually set it there for now.
@@ -567,7 +566,7 @@ def build(self, filter: str = "*"):
567566

568567
_log.info("Writing docs pages")
569568
self.write_doc_pages(pages, filter)
570-
self.renderer.pages_written()
569+
self.renderer._pages_written(self)
571570

572571
# inventory ----
573572

quartodoc/renderers/base.py

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,6 @@ class Renderer:
4040
style: str
4141
_registry: "dict[str, Renderer]" = {}
4242

43-
builder: "Builder"
44-
"""The builder that uses this renderer for generating docs"""
45-
4643
def __init_subclass__(cls, **kwargs):
4744
super().__init_subclass__(**kwargs)
4845

@@ -88,12 +85,22 @@ def from_config(cls, cfg: "dict | Renderer | str"):
8885
def render(self, el):
8986
raise NotImplementedError(f"render method does not support type: {type(el)}")
9087

91-
def pages_written(self):
88+
def _pages_written(self, builder: "Builder"):
9289
"""
9390
Called after all the qmd pages have been render and written to disk
9491
9592
It is called before the documented items are written to an inventory
9693
file. This is a chance for the renderer to add to the documented items
9794
and write the pages to them to disk.
95+
96+
Parameters
97+
----------
98+
builder :
99+
There builder using this renderer to generate documentation.
100+
101+
Notes
102+
-----
103+
This method is provided for experimental purposes and it is not bound
104+
to be available for long, or have the same form.
98105
"""
99106
...

0 commit comments

Comments
 (0)