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

Fixes gallery ToC #85

Merged
merged 2 commits into from Jan 12, 2023
Merged

Fixes gallery ToC #85

merged 2 commits into from Jan 12, 2023

Conversation

melissawm
Copy link
Member

@melissawm melissawm commented Jan 6, 2023

Description

  • Orders gallery by example title
  • Restores left sidebar for individual example pages

Type of change

  • Fixes or improves existing content
  • Adds new content page(s)
  • Fixes or improves workflow, documentation build or deployment

References

Closes napari/napari#5057
Closes napari/napari#4963

This PR also depends on napari/napari#5458

Final checklist:

  • My PR is the minimum possible work for the desired functionality
  • I have commented my code, particularly in hard-to-understand areas
  • I have added alt text to new images included in this PR

- Orders gallery by example title
- Restores left sidebar for individual example pages
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 6, 2023
@melissawm melissawm mentioned this pull request Jan 6, 2023
12 tasks
@melissawm
Copy link
Member Author

Before:

before

After:

after

@psobolewskiPhD
Copy link
Member

I love this fix for the ToC, but when I download the build docs from this PR I don't see the gallery of thumbnails anymore:
image
Also, is it possible to get rid of the now useless Tags submenu here:
image
IOW, just have the Gallery ToC list the tags?

@melissawm
Copy link
Member Author

That is strange 🤔 I do see them locally so will investigate - thanks for checking.

@melissawm
Copy link
Member Author

Argh - of course this is not working correctly, because it depends on napari/napari#5458. Once the two PRs are merged, then we'll see the correct result. If you want to build locally and try it, you can check out both prs and build the docs. Sorry about the confusion 😅

@melissawm
Copy link
Member Author

Also, is it possible to get rid of the now useless Tags submenu here:

This is a little bit trickier, because the toctree to generate that submenu is like this:

```{toctree}
:maxdepth: 1

_tags/tagsindex
```

where tagsindex is populated by the tags that are found during the docs build. I will try to play around with this a little

@psobolewskiPhD
Copy link
Member

Argh - of course this is not working correctly, because it depends on napari/napari#5458. Once the two PRs are merged, then we'll see the correct result. If you want to build locally and try it, you can check out both prs and build the docs. Sorry about the confusion 😅

Oh my bad!
Anyhow, I did that and it works!

@DragaDoncila DragaDoncila merged commit b5147de into napari:main Jan 12, 2023
@psobolewskiPhD psobolewskiPhD added this to the 0.4.18 milestone Jun 22, 2023
@melissawm melissawm deleted the gallery-toc branch January 9, 2024 14:06
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

Successfully merging this pull request may close these issues.

Gallery ToC shows both tags and individual examples DOC Sidebar ToC missing in gallery examples
3 participants