Links to Gallery in docs #5009
Merged
Links to Gallery in docs #5009
Conversation
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
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
bjlittle
requested changes
Nov 9, 2022
Member
bjlittle
left a comment
bjlittle
left a comment
There was a problem hiding this comment.
@ESadek-MO I think it's really great to link to the gallery from the user-guide, as it provides a relevant self-contained worked example for the user.
Just a couple of minor comments to address.
Also, in general I feel that the links to the gallery are somewhat lost in the noise of the page.
To make them standout could you instead enclose them all within the .. seealso:: directive e.g., for cube statistics have:
===============
Cube Statistics
===============
.. seealso::
Relevant gallery example :ref:`sphx_glr_generated_gallery_general_plot_zonal_means.py` (Collapsing)Which renders as:
which has a wee bit more impact.
What do you think? 🤔
bjlittle
reviewed
Nov 10, 2022
bjlittle
approved these changes
Nov 10, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
🚀 Gallery Links
Closes #4781
Description
Created some links within the User Guide to link to relevant gallery pages.