Skip to content

Commit ad6566a

Browse files
committed
docs: describe objects-test.txt a bit
1 parent 4d67346 commit ad6566a

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

docs/get-started/interlinks.qmd

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,17 +43,22 @@ interlinks:
4343
url: https://numpy.org/doc/stable/
4444
python:
4545
url: https://docs.python.org/3/
46+
quartodoc-test:
47+
url: https://machow.github.io/quartodoc
48+
inv: objects-test.txt
4649
```
4750
4851
Notice 2 important pieces in this config:
4952
5053
* The `numpy` and `python` fields indicate that we're getting inventories for the
5154
library numpy, and python builtin libraries.
5255
* 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`.
5357

5458
By default, downloaded inventory files will be saved in the `_inv` folder of your
5559
documentation directory.
5660

61+
5762
### Experimental fast option
5863

5964
Use the experimental `fast: true` option to speed up the interlinks filter.
@@ -175,6 +180,9 @@ Most sphinx sites name them `object.inv`:
175180
See the [sphobjinv docs](https://sphobjinv.readthedocs.io/en/stable/) for thorough
176181
details on these files, and how they're used in sphinx.
177182

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+
:::
178186

179187
## More information
180188

@@ -185,7 +193,3 @@ For an overview of the sphinx inventory format, see [the sphobjinv docs](https:/
185193

186194
The rough idea is that this plugin will behave similar to [jupyterbook linking](https://jupyterbook.org/en/stable/content/references.html),
187195
which supports both some intersphinx syntax, but also markdown syntax.
188-
189-
## Test interlinks cross site
190-
191-
[](`qd2.Auto`)

0 commit comments

Comments
 (0)