Skip to content

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

Open
@goekce

Description

@goekce

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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions