fix: broken github link on generated documentation pages

[cocobennett]

Fix #11919

Currently trying to use the fix listed on sphinx-doc/sphinx#2386

[MrMino]

Hmm... this is taken from https://github.com/readthedocs/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/breadcrumbs.html, is it?

Looks like this is already inside sphinx-rtd-theme - why does it have to be added separately?

[cocobennett]

@MrMino Thanks, you're right. I just need to figure out how to make sure to only show the link if the url is valid

[cocobennett]

Unfortunately, I have no idea how to verify or test the documentation works here in the UI or locally, so I'm closing for now. :(

[MrMino]

@cocobennett Don't hesitate to ask if something is unclear 🙂. You can generate the docs locally by issuing the following commands from the repository root:

pip install -r docs/requirements.txt pytest nose testpath
cd docs/
make html

Afterwards you'll find the index page of the docs under docs/build/html/index.html.

[cocobennett]

@MrMino My last commit removes the link for all pages. It looks like the link can't be removed for only generated pages until readthedocs/sphinx_rtd_theme#252 is fixed. What is your recommendation?

[cocobennett]

Hey there, following up. Does anyone have a recommendation here?

[MrMino]

@cocobennett Sorry, got distracted and forgot to respond. Could you please summarize what is going on on the sphinx-rtd-theme side? The info in these issues is reliant on previous knowledge about the internals of RTD/theme, and I don't have much of it.

[Carreau]

Oh, look like you added PNG as part of b8ade5c, I've amended your last commit.

I think we can merge this and see how it's behaving on readthedocs and iterate.

Before merging and just to make sure, it looks like your first commit is referencing a different email than the others (potentially work email), and another have a different name, I want to make sure you are not non intentionally revealing private informations, and that this is ok.

let us know if you need help amending the authoring informations.

[cocobennett]

@cocobennett Sorry, got distracted and forgot to respond. Could you please summarize what is going on on the sphinx-rtd-theme side? The info in these issues is reliant on previous knowledge about the internals of RTD/theme, and I don't have much of it.

It looks like the issue of telling the difference between a generated page that will lead to a 404 vs an actual page has to be fixed first within sphinx-rtd-theme before anything can be done here to fix, or at least that's what I've gathered

[cocobennett]

Oh, look like you added PNG as part of b8ade5c, I've amended your last commit.

I think we can merge this and see how it's behaving on readthedocs and iterate.

Before merging and just to make sure, it looks like your first commit is referencing a different email than the others (potentially work email), and another have a different name, I want to make sure you are not non intentionally revealing private informations, and that this is ok.

let us know if you need help amending the authoring informations.

Yes! That was from a different account before I re-configured my local setup. I am okay with it staying in. Thanks for the PNG fix and for asking :)

[cocobennett]

@cocobennett Sorry, got distracted and forgot to respond. Could you please summarize what is going on on the sphinx-rtd-theme side? The info in these issues is reliant on previous knowledge about the internals of RTD/theme, and I don't have much of it.

It looks like the issue of telling the difference between a generated page that will lead to a 404 vs an actual page has to be fixed first within sphinx-rtd-theme before anything can be done here to fix, or at least that's what I've gathered

Well, it looks like it was fixed in the theme, so I don't know why I can't get it to tell the difference https://github.com/readthedocs/sphinx_rtd_theme/pull/393/files

[cocobennett]

Trying suggestion here sphinx-doc/sphinx#2386 (comment)

I tested it locally, but seems to act differently when generated in the PR, so trying both

[Carreau]

I tested it locally, but seems to act differently when generated in the PR, so trying both

Let's try to merge and see how it affects the doc; I know that readthedocs sometime use a different version of the theme. So that may be why.

If you convert it back to non-draft I'm happy to merge this.

[Carreau]

Thanks ! Let's see how it renders on readthedocs in a couple of hours.

[MrMino]

I don't think this fixed the problem, unfortunately. The links that #11919 mentions are still visible & broken.