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
Comments
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. |
I don't know for the coordinates ones, but for the io examples which are mostly |
@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 |
@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 :) |
Simon and I tackled |
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).
The text was updated successfully, but these errors were encountered: