Skip to content
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.

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

cross-references.md: Handling names with spaces #991

Open
goekce opened this issue Oct 27, 2024 · 0 comments
Open

cross-references.md: Handling names with spaces #991

goekce opened this issue Oct 27, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@goekce
Copy link
Contributor

goekce commented Oct 27, 2024

Describe the gap in the current documentation

I followed

### Cross-project (intersphinx) links

However, I spent significant time figuring out how to link the following name with spaces:

$ myst-inv https://ipywidgets.readthedocs.io/en/latest -n "examples/Using Interact"

name: Jupyter Widgets
version: '8.1'
base_url: https://ipywidgets.readthedocs.io/en/latest
objects:
  std:
    doc:
      examples/Using Interact:
        loc: examples/Using%20Interact.html
        text: Using Interact

For example the following did not work:

<inv:ipywidgets:std:doc#examples/Using Interact>
<inv:ipywidgets:std:doc#examples/"Using Interact">

It turns out one has to encode the spaces:

<inv:ipywidgets:std:doc#examples/Using%20Interact>

The documentation above does not include info about how to encode spaces.

Describe the solution you'd like

I would like to add a paragraph about encoding spaces. What do you think?

@goekce goekce added the documentation Improvements or additions to documentation label Oct 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant