executablebooks / MyST-Parser

An extended commonmark compliant parser, with bridges to docutils/sphinx
https://myst-parser.readthedocs.io
MIT License
730 stars 192 forks source link

Linking to documentation heading #847

Open LecrisUT opened 8 months ago

LecrisUT commented 8 months ago

Describe the gap in the current documentation

Let's say that we want to link to sphinx:usage/quickstart#intersphinx. Navigating through sphinx's objects.inv we find the relative object std.doc.usage/quickstart pointing to the page we want to reference, but then, how do we go from there to use the documentation page heading? The closest thing we find in the documentation is std.label.code-examples, but in this case it does not have an explicit label to reference.

Basically, what would the user use in this situation?

[Link to doc][usage/quickstart]
[Link to doc#heading][intersphinx]

[usage/quickstart]: inv:sphinx:std:doc#usage/quickstart
<!-- [intersphinx]: inv:sphinx:std:doc#usage/quickstart#interpshinx -->
[intersphinx]: https://www.sphinx-doc.org/en/master/usage/quickstart.html#intersphinx

Describe the solution you'd like

No response