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

Breadcrumbs are problematic (in version 1.1.4) #527

Open
franzinc opened this issue Feb 15, 2024 · 4 comments
Open

Breadcrumbs are problematic (in version 1.1.4) #527

franzinc opened this issue Feb 15, 2024 · 4 comments

Comments

@franzinc
Copy link

I have an internal link checker (written in Common Lisp) and it's been a real challenge to get my internal documentation to pass with no bad links. There are many, many false positives. Why? Because of the breadcrumbs. They look like this:

<div class="main with-sidebar">
  <div class="breadcrumbs"><a href="/">Home</a> / <a href="/readme">readme</a> / <a href="/readme/agraph">agraph</a> / 
    <span>attributes-index-opt-performance</span>
  </div><h1 id="attributes-index-opt-performance">attributes-index-opt-performance</h1>

What's wrong is that /readme/agraph really should be /readme/agraph/, because when the base URI without the slash is merged with a document, say, foo.md, then it will produce /readme/foo.md instead of /readme/agraph/foo.md.

In all other places, the trailing slash is included.

It would be extremely helpful (I don't know how to workaround this in the link checker) if the trailing slash could be included. In this case, you know that the breadcrumbs are directories so including the trailing / is always the right thing.

Thank you.

@franzinc
Copy link
Author

franzinc commented Feb 15, 2024

Btw, I figured the fix would be pretty easy, but when I did git grep -i breadcrumbs it had no hits. So, maybe the real bug is in a dependent project?

@franzinc
Copy link
Author

If someone can give me a pointer to what generates the breadcrumbs, then I can work to fix it and provide a pull request. Thanks.

@evaleev
Copy link
Contributor

evaleev commented Feb 20, 2024

it appears they are added by Sphinx's Alabaster "theme": https://allabaster.readthedocs.io/en/latest/ ...

@franzinc
Copy link
Author

it appears they are added by Sphinx's Alabaster "theme": https://allabaster.readthedocs.io/en/latest/ ...

Does that mean we can choose another config to work around this? I looked at the docs and didn't see anything about a config option to change and what the allowed values might be for it.

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

No branches or pull requests

2 participants