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

DOC: Move sphinx-gallery examples out of core (this) repository #16175

Open
pllim opened this issue Mar 7, 2024 · 6 comments
Open

DOC: Move sphinx-gallery examples out of core (this) repository #16175

pllim opened this issue Mar 7, 2024 · 6 comments

Comments

@pllim
Copy link
Member

pllim commented Mar 7, 2024

Motivation: These examples have not been updated nor expanded for a very long time. We have Learn Astropy for these sorts of tutorials. Removing these would free us from sphinx-gallery and speed up doc build (xref #16161).

Cons: Would be impossible to test these examples in PRs (using the RTD job). (Though some people see this as "pros" instead because they do not want the overhead.)

At the 2024-03-07 dev telecon, there was an idea to move these examples to their own repo(?) and only build them against stable astropy (maybe via a cron job or as part of the release process).

@mhvk
Copy link
Contributor

mhvk commented Mar 7, 2024

I like the idea of moving the examples out - but having some way that we are sure to test them on cron or before a new release.

@saimn
Copy link
Contributor

saimn commented Mar 8, 2024

I don't know for the coordinates ones, but for the io examples which are mostly io.fits, most of the examples are already in the docs. Would not be too difficult to integrate the missing ones.
Arguably it's a bit more difficult to find how to do basic things in the docs since examples there are a bit everywhere. Maybe the should a Quickstart/How to do basic things page with the most common examples.

@pllim
Copy link
Member Author

pllim commented Mar 8, 2024

@saimn , there is already an extensive "Getting Started" section. Won't adding a similarly named "Quick Start" be confusing?

https://docs.astropy.org/en/latest/io/fits/index.html#getting-started

@saimn
Copy link
Contributor

saimn commented Mar 11, 2024

@pllim - Right, and most examples are already there. The one that is missing in the docs is https://docs.astropy.org/en/latest/generated/examples/io/skip_create-large-fits.html#sphx-glr-generated-examples-io-skip-create-large-fits-py but this should probably go somewhere more hidden, maybe in the FAQ. It's not really an example for newcomers :)

@pllim
Copy link
Member Author

pllim commented Mar 13, 2024

@saimn , turns out the FITS landing page link to most of them, except one. How does #16194 look?

@pllim
Copy link
Member Author

pllim commented Mar 18, 2024

Simon and I tackled io in #16194 . When I have time (read: procrastinate), I will go for coordinates! 🔥

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants