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

feat: Update relative links in docstrings of objects from other packages #626

Open
pawamoy opened this issue Oct 15, 2023 · 0 comments
Open
Labels
feature New feature or request

Comments

@pawamoy
Copy link
Member

pawamoy commented Oct 15, 2023

Is your feature request related to a problem? Please describe.
Sometimes we render objects from other packages, or objects inherited from classes from other packages. If these objects contain relative links, these links should be fixed to be absolute instead, since they refer to parts of their own docs, not of ours, and would lead to 404s, or sometimes incorrect parts (same page URL/name, missing fragment, etc.).

Similarly, autorefs links should be fixed too, depending on their originating package. For example, autorefs links in a docstring of an object coming from copier should be made absolute using Copier's docs URL, not relative to our own. Without that, duplicate autorefs ids across docstrings from different packages would clash and lead to incorrect results.

Describe the solution you'd like
Relative (autorefs) links should be made absolute if coming from other packages.

Describe alternatives you've considered
/

Additional context
/

@pawamoy pawamoy added the feature New feature or request label Oct 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant