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

Create custom examples gallery #106

Closed
Tracked by #197
jacobtomlinson opened this issue Jan 20, 2023 · 0 comments · Fixed by #118
Closed
Tracked by #197

Create custom examples gallery #106

jacobtomlinson opened this issue Jan 20, 2023 · 0 comments · Fixed by #118
Assignees
Labels
sphinx Related to the Sphinx theme powering these docs

Comments

@jacobtomlinson
Copy link
Member

As outlined in rapidsai/cloud-ml-examples#197 we need to have a gallery-style page showing all of the example notebooks with their associated tags. We then need to add a filtering sidebar menu to allow users to find the notebooks they are interested in.

image

I expect this involves writing a custom directive that walks the toctree discovering the notebooks. Then walking the notebooks and loading the tags from the first cell metadata. Then render out the grid using the same nodes we are building manually on other pages currently.

For the filtering sidebar we need to drop in a custom sidebar object with all of the tag categories and then write some client-side JavaScript to show/hide grid items depending on which filters are checked.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
sphinx Related to the Sphinx theme powering these docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant