@@ -43,17 +43,22 @@ interlinks:
43
43
url : https://numpy.org/doc/stable/
44
44
python :
45
45
url : https://docs.python.org/3/
46
+ quartodoc-test :
47
+ url : https://machow.github.io/quartodoc
48
+ inv : objects-test.txt
46
49
` ` `
47
50
48
51
Notice 2 important pieces in this config:
49
52
50
53
* The ` numpy` and `python` fields indicate that we're getting inventories for the
51
54
library numpy, and python builtin libraries.
52
55
* The `url` fields indicate where inventory files can be found.
56
+ * The `inv` field lets you specify the name of the inventory file. By default, it assumes its `objects.inv`.
53
57
54
58
By default, downloaded inventory files will be saved in the `_inv` folder of your
55
59
documentation directory.
56
60
61
+
57
62
# ## Experimental fast option
58
63
59
64
Use the experimental `fast : true` option to speed up the interlinks filter.
@@ -175,6 +180,9 @@ Most sphinx sites name them `object.inv`:
175
180
See the [ sphobjinv docs] ( https://sphobjinv.readthedocs.io/en/stable/ ) for thorough
176
181
details on these files, and how they're used in sphinx.
177
182
183
+ :::{.callout-note}
184
+ [ objects-test.txt] ( https://github.com/machow/quartodoc/tree/main/docs/objects-test.txt ) is an example file with one entry: [ ] ( `qd2.Auto` ) .
185
+ :::
178
186
179
187
## More information
180
188
@@ -185,7 +193,3 @@ For an overview of the sphinx inventory format, see [the sphobjinv docs](https:/
185
193
186
194
The rough idea is that this plugin will behave similar to [ jupyterbook linking] ( https://jupyterbook.org/en/stable/content/references.html ) ,
187
195
which supports both some intersphinx syntax, but also markdown syntax.
188
-
189
- ## Test interlinks cross site
190
-
191
- [ ] ( `qd2.Auto` )
0 commit comments