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

Non predictable permalinks when multiple automodapi directive is used #145

Open
bsipocz opened this issue Apr 5, 2022 · 0 comments
Open
Labels

Comments

@bsipocz
Copy link
Member

bsipocz commented Apr 5, 2022

Identified as an issue in astropy/pyvo#289 (comment)

E.g. here the first one gets the classes and functions link, but the rest just a numbered ID, which is then not very informative to be used elsewhere as a reference, as well as non-future proof, basically making these headings useless to be cross-linked.

Example from the astropy core docs:
docs/modeling/reference_api.rst
https://docs.astropy.org/en/stable/modeling/reference_api.html

One solution could be that the module names are inherited into those heading links, e.g.
https://docs.astropy.org/en/stable/modeling/reference_api.html#functions becomes https://docs.astropy.org/en/stable/modeling/reference_api.html#module-astropy.modeling.functions

While https://docs.astropy.org/en/stable/modeling/reference_api.html#id9 becomes https://docs.astropy.org/en/stable/modeling/reference_api.html#module-astropy.modeling.statistic.functions

@bsipocz bsipocz added the bug label Apr 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant