Skip to content

Commit 0ca5b4b

Browse files
committed
Add Renderer.pages_written callback
This gives the interested Renderer a sane marker to implement custom functionality.
1 parent e9c90c8 commit 0ca5b4b

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

quartodoc/autosummary.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -567,6 +567,7 @@ def build(self, filter: str = "*"):
567567

568568
_log.info("Writing docs pages")
569569
self.write_doc_pages(pages, filter)
570+
self.renderer.pages_written()
570571

571572
# inventory ----
572573

quartodoc/renderers/base.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,3 +87,13 @@ def from_config(cls, cfg: "dict | Renderer | str"):
8787
@dispatch
8888
def render(self, el):
8989
raise NotImplementedError(f"render method does not support type: {type(el)}")
90+
91+
def pages_written(self):
92+
"""
93+
Called after all the qmd pages have been render and written to disk
94+
95+
It is called before the documented items are written to an inventory
96+
file. This is a chance for the renderer to add to the documented items
97+
and write the pages to them to disk.
98+
"""
99+
...

0 commit comments

Comments
 (0)