diff --git a/CHANGELOG.md b/CHANGELOG.md index ff2d904f..0b4068ac 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Changelog +## Unreleased + +### 📚 Documentation + +- 📚 Explain how to percent-encode spaces in inventory autolinks (#991) + ## 5.1.0 - 2026-05-13 ### ✨ New Features diff --git a/docs/syntax/cross-referencing.md b/docs/syntax/cross-referencing.md index 18d2e224..484b0b45 100644 --- a/docs/syntax/cross-referencing.md +++ b/docs/syntax/cross-referencing.md @@ -347,6 +347,8 @@ myst-inventories: you can then reference inventory objects by prefixing the `inv` schema to the destination [URI]: `inv:key:domain:type#name`. +For object names containing spaces, percent-encode the spaces as `%20` in an `inv` autolink, for example ``. + `key`, `domain` and `type` are optional, e.g. for `inv:#name`, all inventories, domains and types will be searched, with a [warning emitted](myst-warnings) if multiple matches are found. Additionally, `*` is a wildcard which matches zero or more characters, e.g. `inv:*:std:doc#a*` will match all `std:doc` objects in all inventories, with a `name` beginning with `a`.