File tree Expand file tree Collapse file tree 2 files changed +12
-6
lines changed Expand file tree Collapse file tree 2 files changed +12
-6
lines changed Original file line number Diff line number Diff line change @@ -507,7 +507,6 @@ def __init__(
507
507
self .parser = parser
508
508
509
509
self .renderer = Renderer .from_config (renderer )
510
- self .renderer .builder = self
511
510
if render_interlinks :
512
511
# this is a top-level option, but lives on the renderer
513
512
# so we just manually set it there for now.
@@ -567,7 +566,7 @@ def build(self, filter: str = "*"):
567
566
568
567
_log .info ("Writing docs pages" )
569
568
self .write_doc_pages (pages , filter )
570
- self .renderer .pages_written ( )
569
+ self .renderer ._pages_written ( self )
571
570
572
571
# inventory ----
573
572
Original file line number Diff line number Diff line change @@ -40,9 +40,6 @@ class Renderer:
40
40
style : str
41
41
_registry : "dict[str, Renderer]" = {}
42
42
43
- builder : "Builder"
44
- """The builder that uses this renderer for generating docs"""
45
-
46
43
def __init_subclass__ (cls , ** kwargs ):
47
44
super ().__init_subclass__ (** kwargs )
48
45
@@ -88,12 +85,22 @@ def from_config(cls, cfg: "dict | Renderer | str"):
88
85
def render (self , el ):
89
86
raise NotImplementedError (f"render method does not support type: { type (el )} " )
90
87
91
- def pages_written (self ):
88
+ def _pages_written (self , builder : "Builder" ):
92
89
"""
93
90
Called after all the qmd pages have been render and written to disk
94
91
95
92
It is called before the documented items are written to an inventory
96
93
file. This is a chance for the renderer to add to the documented items
97
94
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.
98
105
"""
99
106
...
You can’t perform that action at this time.
0 commit comments