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

Add related examples section #107

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

Add related examples section #107

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

Comments

@jacobtomlinson
Copy link
Member

As described in rapidsai/cloud-ml-examples#197 we need to add a "Related Examples" section to the bottom of each documentation page and crosslink with example notebooks.

image

I expect this will involve creating a custom directive or footer at the bottom of each page that walks the toctree of the examples section. Then walk the notebooks and load the cell metadata tags from the title cell. Then if the notebook tag matches the name of the page, e.g ec2 a grid item should be generated to link to that notebook.

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