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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs are missing the anchor links #2034

Closed
awaelchli opened this issue May 31, 2020 · 8 comments 路 Fixed by #3908
Closed

Docs are missing the anchor links #2034

awaelchli opened this issue May 31, 2020 · 8 comments 路 Fixed by #3908
Assignees
Labels
docs Documentation related good first issue Good for newcomers help wanted Open to be worked on

Comments

@awaelchli
Copy link
Member

awaelchli commented May 31, 2020

馃摎 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 awaelchli added the docs Documentation related label May 31, 2020
@awaelchli awaelchli self-assigned this May 31, 2020
@Borda Borda added good first issue Good for newcomers help wanted Open to be worked on labels Jun 2, 2020
@awaelchli
Copy link
Member Author

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
Copy link
Member Author

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

@Borda
Copy link
Member

Borda commented Aug 4, 2020

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

@Borda Borda closed this as completed Aug 4, 2020
@awaelchli
Copy link
Member Author

@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
Copy link
Contributor

ydcjeff commented Oct 6, 2020

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

@ydcjeff
Copy link
Contributor

ydcjeff commented Oct 6, 2020

Btw, what is the issue tho? @awaelchli

@awaelchli
Copy link
Member Author

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
Copy link
Contributor

ydcjeff commented Oct 6, 2020

I think could it be fixed with autosummary?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related good first issue Good for newcomers help wanted Open to be worked on
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants