feat: add render_interlinks option to Builder

Author: machow

.flake8

@@ -1,3 +1,4 @@
+[flake8]
 exclude = docs, test_*, .flake8
 max-line-length = 90
 ignore =

docs/get-started/interlinks.qmd

@@ -55,6 +55,20 @@ By default, downloaded inventory files will be saved in the `_inv` folder of you
 documentation directory.
 
 
+### Rendering interlinks in API docs
+
+quartodoc can convert type annotations in function signatures to interlinks.
+
+In order to enable this behavior, set `render_interlinks: true` in the quartodoc config.
+
+
+```yaml
+quartodoc:
+  render_interlinks: true
+```
+
+
+
 ## Running the interlinks filter
 
 First, build the reference for your own site, which includes an objects.json inventory:

quartodoc/autosummary.py

@@ -391,6 +391,9 @@ class Builder:
     dynamic:
         Whether to dynamically load all python objects. By default, objects are
         loaded using static analysis.
+    render_interlinks:
+        Whether to render interlinks syntax inside documented objects. Note that the
+        interlinks filter is required to generate the links in quarto.
 
     """
 
@@ -436,6 +439,7 @@ def __init__(
         source_dir: "str | None" = None,
         dynamic: bool | None = None,
         parser="numpy",
+        render_interlinks: bool = False,
     ):
         self.layout = self.load_layout(sections=sections, package=package)
 
@@ -447,6 +451,10 @@ def __init__(
         self.parser = parser
 
         self.renderer = Renderer.from_config(renderer)
+        if render_interlinks:
+            # this is a top-level option, but lives on the renderer
+            # so we just manually set it there for now.
+            self.renderer.render_interlinks = render_interlinks
 
         if out_index is not None:
             self.out_index = out_index