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

Link to relative paths #144

Closed
yajo opened this issue Aug 13, 2020 · 2 comments
Closed

Link to relative paths #144

yajo opened this issue Aug 13, 2020 · 2 comments
Assignees
Labels
bug Something isn't working

Comments

@yajo
Copy link

yajo commented Aug 13, 2020

Describe the bug
When mkdocstrings produces cross-references to docs titles, it uses the full path starting from site_url. That setting cannot be changed dynamically. When you build several versions of your docs, at least one of them will always fail.

To Reproduce
Steps to reproduce the behavior:

  1. Go to https://copier--254.org.readthedocs.build/en/254/api/reference/cli/#copier.cli.CopierApp and click on "skip_if_exists"
  2. It takes you to https://copier.readthedocs.io/configuring/#skip_if_exists, which of course fails.

Expected behavior
It should take you to https://copier--254.org.readthedocs.build/en/254/configuring/#skip_if_exists instead.

Screenshots
Peek 13-08-2020 12-45

Information (please complete the following information):

  • OS: Linux
  • Browser: Firefox
  • mkdocstrings version: mkdocstrings==0.12.2

Additional context
That doc is built from copier-org/copier#254 where you can see the full source code.

@yajo yajo added the unconfirmed This bug was not reproduced yet label Aug 13, 2020
yajo pushed a commit to copier-org/copier that referenced this issue Aug 13, 2020
This will reduce friction while testing docs in PRs until mkdocstrings/mkdocstrings#144 is fixed.
github-actions bot pushed a commit to copier-org/copier that referenced this issue Aug 13, 2020
This will reduce friction while testing docs in PRs until mkdocstrings/mkdocstrings#144 is fixed.
@pawamoy pawamoy added bug Something isn't working references and removed unconfirmed This bug was not reproduced yet labels Sep 3, 2020
@pawamoy pawamoy self-assigned this Sep 3, 2020
@pawamoy
Copy link
Member

pawamoy commented Sep 3, 2020

Hey @yajo! Sorry it took so long for me to take a look at this. I finally have some time to work on my projects 🙂

So, this is clearly a bug, and I was never satisfied with using absolute URLs anyway. I'm going to rework the objects-URL mapping code to use relative links.

Thanks for the detailed report!

@pawamoy pawamoy closed this as completed in 9c77f1f Sep 3, 2020
@pawamoy
Copy link
Member

pawamoy commented Sep 3, 2020

Fixed in 9c77f1f and version 0.13.1 is on its way 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants