-
Notifications
You must be signed in to change notification settings - Fork 31
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 #111
Add related examples #111
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, modulo that one comment
There is no way to access the site that the CI built right? Just asking because it would be convenient but not required. |
Co-authored-by: Tim Head <[email protected]>
Thanks for the review!
Not currently. I opened https://github.com/rapidsai/ops/issues/2413 a while back to ask Ops to set this up but they haven't gotten to it yet. |
Closes #107
High level changes:
relatedexamples
directive for use on pages to show related notebooksAdded(Split out into Add ruff to the repo linters #113)ruff
for lintingBy adding cell metadata tags to the first cell of a notebook those tags get added to the Sphinx notebook tag mapping. For example I added a
cloud/aws/sagemaker
tag to the Sagemaker notebook.Then when you use the
relatedexamples
directive on a page it checks for any tags that match the page name. So using it insource/cloud/aws/sagemaker.md
means it will find the Sagemaker notebook and link to it.There are a few outstanding issues with the PR, but I'm keen to keep moving forwards and open separate issues to track those:
The example link currently uses the doc name rather than the example title because Sphinx hasn't parsed the titles yet at the point I'm processing the directiveFixed in 9e37293.