You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/get-started/docstring-examples.qmd
+26-1Lines changed: 26 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -105,4 +105,29 @@ def f() -> int:
105
105
A number
106
106
"""
107
107
108
-
```
108
+
```
109
+
110
+
111
+
## Using interlinks in docstrings
112
+
113
+
quartodoc supports linking to functions using the [interlinks quarto filter](./interlinks.qmd) (and linking in general using [quarto link syntax](./crossrefs.qmd)).
114
+
115
+
The code below shows an interlink, along with a regular quarto link.
116
+
117
+
```python
118
+
deff():
119
+
"""A function.
120
+
121
+
Interlinks filter:
122
+
123
+
See [](`quartodoc.get_object`)
124
+
125
+
Regular quarto link (to a page in your docs):
126
+
127
+
See the [reference](/reference/index.qmd) page.
128
+
"""
129
+
```
130
+
131
+
:::{.callout-note}
132
+
Linking to functions documented outside your package must be configured in the [interlinks filter](./interlinks.qmd).
0 commit comments