Add custom Sphinx extension that lists examples based on model name#2859
Merged
jessica-mitchell merged 20 commits intonest:masterfrom Sep 13, 2023
Merged
Add custom Sphinx extension that lists examples based on model name#2859jessica-mitchell merged 20 commits intonest:masterfrom
jessica-mitchell merged 20 commits intonest:masterfrom
Conversation
pnbabu
suggested changes
Aug 15, 2023
Contributor
pnbabu
left a comment
There was a problem hiding this comment.
I think sorting the list of files by title text rather than the filenames is more useful. I see that it's listed as a TODO in this PR. Is that planned to be addressed here?
Contributor
Author
|
@pnbabu I finally managed to sort the examples by title; this required a fair bit of reworking the extension script so its quite different now |
pnbabu
approved these changes
Sep 11, 2023
Contributor
pnbabu
left a comment
There was a problem hiding this comment.
Looks good to me! This list is super helpful for someone browsing through the models. I think we could add the directive to all model files once you have approval from other reviewers as well.
terhorstd
approved these changes
Sep 12, 2023
Contributor
terhorstd
left a comment
There was a problem hiding this comment.
Two bytes to cut, then I think it's ready to go.
Thanks for the cool upgrade! 👍
Co-authored-by: Dennis Terhorst <terhorstd@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a custom Sphinx extension that displays a list of examples based on model name.
How to use it
Add directive to reStructured Text with required argument - the model_name:
.. listexamples:: model_nameThis was used in
models/iaf_psc_alpha.handaeif_cond_alphaSee output here
Updated
TODO