Skip to content

📚 Document spaces in inventory object names #1163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
sapunyangkut wants to merge 1 commit into
base: master
Choose a base branch
from
+8 −0
Draft

📚 Document spaces in inventory object names #1163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/syntax/cross-referencing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<inv:ipywidgets:std:doc#examples/Using%20Interact>`.

`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`.
Expand Down