Pytorch-lightning: Docs are missing the anchor links

[awaelchli]

📚 Documentation

As pointed out by @oplatek the docs suddenly miss the anchor button that allows one to generate a link that points to a particular resource within a page.

This was working before, but now there is a 404 when accessing some assets (js, css, ...)

EDIT: seems not related to the 404 seen in the JS console.

[awaelchli]

I noticed the following:

1. The anchor links for title sections are there
2. The anchor links are only missing for the class/method/function definitions in the docs composed in .rst files.
3. If you search for the class/function in the search box and click on the result, you get to a page where all the anchor links are there. For example, compare this vs. this.

So it seems the theme is only inserting the anchor links in autogenerated docs, but not the handwritten .rst files.

No idea how to fix it still...

[awaelchli]

I think this is the issue:
https://github.com/sphinx-doc/sphinx/issues/7052
All docs that have :noindex: in the automodule/autoclass don't get the permalink

[Borda]

so there is nothing we can do about it... @awaelchli, right?

[awaelchli]

@Borda We will be when they release the new sphinx version. We can replace the :noindex: with :noindexentry: and it should show the links.

[ydcjeff]

Is this still an issue? I would like to take it.

[ydcjeff]

Btw, what is the issue tho? @awaelchli

[awaelchli]

have not made progress. so I'm happy if you can take it. as mentioned on slack, I believe the links are missing because we have two types of docs and we can't index both, and one has the :noindex: label, which causes links to disappear.

[ydcjeff]

I think could it be fixed with autosummary?