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

Linking to documentation heading #847

Open
LecrisUT opened this issue Dec 18, 2023 · 0 comments
Open

Linking to documentation heading #847

LecrisUT opened this issue Dec 18, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@LecrisUT
Copy link

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

@LecrisUT LecrisUT added the documentation Improvements or additions to documentation label Dec 18, 2023
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