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

Read the docs structure shows core tutorials nested inside widget tutorials #1964

Closed
h-mayorquin opened this issue Sep 6, 2023 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@h-mayorquin
Copy link
Collaborator

If I clik on the module examples gallery, then core tutorials and finally append and concatenate segments the side menu makes it appears as if this embedded in the widgets tutorials.

image

Not sure why this is the case or if this indicates a deeper error in the structure of our documentation.

@h-mayorquin h-mayorquin added the documentation Improvements or additions to documentation label Sep 6, 2023
@h-mayorquin h-mayorquin changed the title Read the docs structure structure nests core tutorials inside widget tutorials Read the docs structure shows core tutorials nested inside widget tutorials Sep 6, 2023
@zm711
Copy link
Collaborator

zm711 commented Sep 6, 2023

@h-mayorquin,
I think it's been like that for ages, someone on an issue recently shared the docs for .96. It was not nested on version 0.13 though, so between 13-96 api change created the nested structure in the docs. I'll look around a bit too.
https://spikeinterface.readthedocs.io/en/0.96.0/modules/index.html

EDIT: https://spikeinterface.readthedocs.io/en/0.13.0/

@zm711
Copy link
Collaborator

zm711 commented Sep 6, 2023

I wonder if we change the order of the modules_gallery so that widgets isn't last, but lets say core is last if the mistake is the same. I looked at the raw build log and nothing looks weird. It must be accidentally creating the nested structure in the index.rst of widgets, but I don't have a clue why. The conf.py looks fine.

@zm711 zm711 mentioned this issue Sep 13, 2023
@zm711
Copy link
Collaborator

zm711 commented Sep 14, 2023

Since I wasn't able to get this fixed locally (soon-ish) I might open a do not merge pull request where I try a bunch of rearranging things to see if I can isolate the issue in the rtd building process.

@zm711
Copy link
Collaborator

zm711 commented Sep 22, 2023

@zm711 zm711 closed this as completed Sep 22, 2023
@h-mayorquin
Copy link
Collaborator Author

This is great, thanks a bunch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants