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

Gallery infrastructure #133

Merged
merged 25 commits into from
Jun 9, 2023
Merged

Gallery infrastructure #133

merged 25 commits into from
Jun 9, 2023

Conversation

jukent
Copy link
Collaborator

@jukent jukent commented Jun 8, 2023

Related to #126 and #128

Adding our own gallery that uses each viz function instead of relying on geocat-examples so that we can decouple the two packages.

@jukent jukent marked this pull request as ready for review June 8, 2023 15:15
@jukent jukent requested review from kafitzgerald and anissa111 June 8, 2023 15:15
@jukent
Copy link
Collaborator Author

jukent commented Jun 8, 2023

I still want to change installation.rst but that can be outside of this PR.

@jukent jukent self-assigned this Jun 8, 2023
@jukent
Copy link
Collaborator Author

jukent commented Jun 8, 2023

Going to add links to new examples in docstrings before merging.

@jukent
Copy link
Collaborator Author

jukent commented Jun 8, 2023

../ ../../ and ../../../ in the relative path from fx docstring to example notebook all seem to point to the same broken link: https://geocat-viz--133.org.readthedocs.build/en/133/user_api/examples/add_height_from_pressure_axis.html when we need this with out the user_api folder in place. Is there something about sphinx read the docs that doesn't let us go up another folder? What we want it to point to is https://geocat-viz--133.org.readthedocs.build/en/133/examples/add_height_from_pressure_axis.html

@jukent
Copy link
Collaborator Author

jukent commented Jun 8, 2023

Sorry I changed this from a draft pre-maturely (before I thought to add links between the fx and its example) and I didn't see a way to turn it back. If tests pass this round I think it is actually ready for review.

@jukent jukent added the documentation Improvements or additions to documentation label Jun 8, 2023
@jukent
Copy link
Collaborator Author

jukent commented Jun 8, 2023

Yay it's working @kafitzgerald

@jukent jukent added the ready for review Development is done and ready for reviews label Jun 8, 2023
Copy link
Collaborator

@kafitzgerald kafitzgerald left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

I know it wasn't the primary objective, but also excited about having usage examples in the viz docs.

@jukent jukent merged commit 20a3928 into NCAR:main Jun 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation ready for review Development is done and ready for reviews
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants