Skip to content

Provide better visibility for Learn Astropy and Coordinated/Affiliated package in core docs - #18409

Merged
pllim merged 4 commits into
astropy:mainfrom
taldcroft:docs-add-learn-coordinated
Aug 1, 2025
Merged

Provide better visibility for Learn Astropy and Coordinated/Affiliated package in core docs#18409
pllim merged 4 commits into
astropy:mainfrom
taldcroft:docs-add-learn-coordinated

Conversation

@taldcroft

@taldcroft taldcroft commented Jul 9, 2025 •
edited
Loading

Copy link
Copy Markdown
Member

Description

As discussed at the 2025 Coordination meeting and in #8221, the astropy core documentation landing page is a good place to highlight parts of the Astropy Project that are outside of the core itself:

  • Learn Astropy
  • Coordinated and Affiliated packages

This PR is a modest step in this direction:

  • Adds a new top-level link for Packages and renames Tutorials to Learn (to be consistent with branding).
  • Adds two new cards Learn Astropy and Astropy Packages.
  • Tightens up the card content by removing the card footers (e.g. no more To the getting started guides button). This reduces unnecessary vertical space and gets more content above the fold on a typical laptop web browser.

Rendered docs: https://astropy--18409.org.readthedocs.build/en/18409/

The discussion in #8221 highlights some excellent ideas that would further improve the documentation, e.g. adapting or using the sunpy sphinx theme and making astropy.org be sphinx-created in order to have a unified look/feel between astropy.org and docs.astropy.org. These efforts would require time and skill that I do not currently have, so this PR is purposely narrow in scope.

Fixes #8221

Please DO squash.

  • By checking this box, the PR author has requested that maintainers do NOT use the "Squash and Merge" button. Maintainers should respect this when possible; however, the final decision is at the discretion of the maintainer that merges the PR.

@taldcroft taldcroft added this to the v7.2.0 milestone Jul 9, 2025
@github-actions

github-actions Bot commented Jul 9, 2025

Copy link
Copy Markdown
Contributor

Thank you for your contribution to Astropy! 🌌 This checklist is meant to remind the package maintainers who will review this pull request of some common things to look for.

  • Do the proposed changes actually accomplish desired goals?
  • Do the proposed changes follow the Astropy coding guidelines?
  • Are tests added/updated as required? If so, do they follow the Astropy testing guidelines?
  • Are docs added/updated as required? If so, do they follow the Astropy documentation guidelines?
  • Is rebase and/or squash necessary? If so, please provide the author with appropriate instructions. Also see instructions for rebase and squash.
  • Did the CI pass? If no, are the failures related? If you need to run daily and weekly cron jobs as part of the PR, please apply the "Extra CI" label. Codestyle issues can be fixed by the bot.
  • Is a change log needed? If yes, did the change log check pass? If no, add the "no-changelog-entry-needed" label. If this is a manual backport, use the "skip-changelog-checks" label unless special changelog handling is necessary.
  • Is this a big PR that makes a "What's new?" entry worthwhile and if so, is (1) a "what's new" entry included in this PR and (2) the "whatsnew-needed" label applied?
  • At the time of adding the milestone, if the milestone set requires a backport to release branch(es), apply the appropriate "backport-X.Y.x" label(s) before merge.

@taldcroft

taldcroft commented Jul 9, 2025

Copy link
Copy Markdown
Member Author

BTW, I got the new icon SVGs from https://fonts.google.com/icons so I assume they are free for use with no license restrictions.

@pllim pllim modified the milestones: v7.2.0, v7.1.1 Jul 9, 2025
pllim
pllim approved these changes Jul 9, 2025
View reviewed changes

@pllim pllim left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Just a nitpick.

Overall, I like this! While it is not fancy like Sunpy theme or MyST thingy, it improves discoverability without the need of infrastructure overhaul.

Thanks!

p.s. Didn't we also talk about a page here with "fancy package logos"?

Comment thread docs/index.rst Resolved
@taldcroft

taldcroft commented Jul 9, 2025

Copy link
Copy Markdown
Member Author

p.s. Didn't we also talk about a page here with "fancy package logos"?

Yeah, I punted that off to another future PR. Making that page would require more work and raise inevitable questions about maintaining the coordinated package list in two places.

@taldcroft @pllim
Update docs/index.rst
a27109c 
Co-authored-by: P. L. Lim <[email protected]>
@pllim

pllim commented Jul 9, 2025

Copy link
Copy Markdown
Member

I'll give others a chance to review but LGTM. Thanks!

@jeffjennings

jeffjennings commented Jul 9, 2025

Copy link
Copy Markdown
Contributor

Thanks for adding this Tom, it looks great!

@taldcroft

taldcroft commented Aug 1, 2025

Copy link
Copy Markdown
Member Author

@pllim - folks have had a few weeks to review this, so can we merge it?

@pllim
pllim merged commit 31564df into astropy:main Aug 1, 2025
meeseeksmachine pushed a commit to meeseeksmachine/astropy that referenced this pull request Aug 1, 2025
@taldcroft @meeseeksmachine
Backport PR astropy#18409: Provide better visibility for Learn Astrop…
9996906 
…y and Coordinated/Affiliated package in core docs
@meeseeksmachine meeseeksmachine mentioned this pull request Aug 1, 2025
Merged
@pllim

pllim commented Aug 1, 2025

Copy link
Copy Markdown
Member

Yes. Merged. :)

pllim added a commit that referenced this pull request Aug 1, 2025
@pllim
Merge pull request #18488 from meeseeksmachine/auto-backport-of-pr-18…
48990a9 
…409-on-v7.1.x

Backport PR #18409 on branch v7.1.x (Provide better visibility for Learn Astropy and Coordinated/Affiliated package in core docs)
@pllim pllim mentioned this pull request Nov 17, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pllim pllim pllim approved these changes
@astrofrog astrofrog Awaiting requested review from astrofrog
@Cadair Cadair Awaiting requested review from Cadair
@bsipocz bsipocz Awaiting requested review from bsipocz

Assignees

No one assigned

Labels

Docs no-changelog-entry-needed

Projects

None yet

Milestone

v7.1.1

Development

Successfully merging this pull request may close these issues.

List astropy coordinated affiliated packages on main documentation page

3 participants

@taldcroft @pllim @jeffjennings