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

Use sphinx.ext.autosectionlabel #257

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

LecrisUT
Copy link
Contributor

@LecrisUT LecrisUT commented Nov 18, 2024

I was trying to link to the hierarchy section using intersphinx links, but I couldn't find the target for it similar to how select is available. This is mostly because the sections are not auto-labeled. This should make linking easier for external documentations.

Not sure if autosectionlabel_prefix_document would also be necessary.

Trying to debug using:

$ myst-inv https://fmf--257.org.readthedocs.build/en/257/
fails
$ python -m sphinx.ext.intersphinx https://fmf--257.org.readthedocs.build/en/257/objects.inv
works

Edit: This does resolve my issue, the only question is if autosectionlabel_prefix_document should be used. I don't know what it does when there are label clashes, but to me it seems prudent to add it

std:label
    hierarchy                                Hierarchy                               : features.html#hierarchy

vs

std:label
    features:hierarchy                       Hierarchy                               : features.html#hierarchy

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant