A better gallery
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4.2k
- Forks
- 1.4k
- Avg merge
- 2d 15h
- Merged PRs (30d)
- 14
Description
What is your issue?
Our current gallery is not great; it contains a fairly arbitrary selection of things you can do from simple to wildly complex (apply_ufunc hehe).
There has been some parallel work:
- For SciPy, a bunch of us (@benbovy @keewis @scottyhq and I) built https://xarray-indexes.readthedocs.io/ (repo at https://github.com/xarray-contrib/xarray-indexes). We built it externally to move quickly and also because the environment on that repo is quite heavy.
- Presumably, @ianhi's work as part of the CZI grant will also involve some sort of gallery (at https://xarray-contrib.github.io/xarray-for-bio/intro.html) with a different set of packages.
It would be nice to figure out a solution where visitors to our docs can discover all available galleries, AND for us to run a CI test that ensures we aren't breaking them.
I don't have any good ideas for how to do this in a sustainable manner at present.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the current gallery at docs.xarray.dev/en/stable/gallery.html and review the linked xarray-indexes and xarray-for-bio galleries. Investigate a sustainable way to expose all galleries and run CI checks for them. Done means visitors can discover the available galleries and CI detects when they break.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- ci-cd, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100