FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Migrate documentation to new unified astropy sphinx theme by Cadair · Pull Request #19206 · astropy/astropy · GitHub

Migrate documentation to new unified astropy sphinx theme - #19206

Merged
astrofrog merged 11 commits into
astropy:mainfrom
Cadair:unified-theme
May 12, 2026
Merged

Migrate documentation to new unified astropy sphinx theme#19206
astrofrog merged 11 commits into
astropy:mainfrom
Cadair:unified-theme

Conversation

Cadair commented Jan 21, 2026
edited
Loading

Copy link
Copy Markdown
Member

Update to use the new astropy sphinx theme, based on pydata-sphinx-theme and sunpy-sphinx-theme.
This work is being tracked here: astropy/astropy-project#522

For comments on the actual theme open issues on https://github.com/astropy/astropy-sphinx-theme

Related issues:

  • 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.

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.

Comment thread docs/units/logarithmic_units.rst Outdated

Cadair commented May 11, 2026

Copy link
Copy Markdown
Member Author

Is this worthy of a changelog?

Cadair added this to the v8.0.0 milestone May 11, 2026

Cadair commented May 11, 2026

Copy link
Copy Markdown
Member Author

I'm going to optimistically milestone this for 8.0 and then send @astrofrog some pizza or something.

Cadair changed the title Test out new unified theme Migrate documentation to new unified astropy sphinx theme May 11, 2026
Cadair marked this pull request as ready for review May 11, 2026 15:22
Cadair requested a review from neutrinoceros as a code owner May 11, 2026 15:22

Copy link
Copy Markdown
Member

I'll be in touch about my preferred toppings!

pllim commented May 11, 2026

Copy link
Copy Markdown
Member

I think he likes cash stuffed crust.

pllim added the backport-v8.0.x on-merge: backport to v8.0.x label May 11, 2026

pllim commented May 11, 2026

Copy link
Copy Markdown
Member

Wow look at how orange it is: https://astropy--19206.org.readthedocs.build/en/19206/

@eteq should be happy now.

pllim commented May 11, 2026

Copy link
Copy Markdown
Member

FWIW we did not include a change log when we switched theme the last time

pllim commented May 11, 2026

Copy link
Copy Markdown
Member

I added some links on the original post as this PR would naturally close a few issues (yay).

Any chance you want to address #15112 also while you are at it?

Copy link
Copy Markdown
Member

@Cadair - generally speaking this looks great and has a nice feel.

I do wonder a bit about the bright orange links, which on some pages seem a bit much, especially on the main user docs index (https://astropy--19206.org.readthedocs.build/en/19206/index_user_docs.html). Is this break from the standard scientific Python docs theme driven by a broader web design principle?

Cadair commented May 11, 2026
edited
Loading

Copy link
Copy Markdown
Member Author

On the light or dark theme?

Is this break from the standard scientific Python docs theme driven by a broader web design principle?

I picked the colours so they were astropy themed. They are the ones from the logo. They can be tweaked but you do need to maintain a high contrast ratio for accessibility.

Cadair commented May 11, 2026

Copy link
Copy Markdown
Member Author

Also, we shouldn't hold this PR up unnecessarily on colour choices. We can repaint the bikeshed to our hearts content over on the theme repo.

The main objectives here are the unified search and the unified navigation bar over all astropy documentation sites.

taldcroft commented May 11, 2026
edited
Loading

Copy link
Copy Markdown
Member

On the light or dark theme?

Both, and the dark theme it is especially bright and jarring.

we shouldn't hold this PR up unnecessarily on colour choices. We can repaint the bikeshed to our hearts content over on the theme repo.

Colour choices matter quite significantly and I would not call this bikeshedding. As you note the intent of this PR is unified infrastructure and theme, but right now this has the consequence of making a major and completely non-standard "interface change" to a widely used astropy page. None of the other major projects deviate from normal blue-tinted links in their web pages.

They can be tweaked but you do need to maintain a high contrast ratio for accessibility.

That might be controversial. I asked gemini "is orange a good color for web page links?"

Orange is an excellent, high-visibility color for call-to-action (CTA) buttons or specific, attention-grabbing links, as it combines energy with warmth to boost conversions. However, it is generally poor for standard body text links, as it lacks the universal recognition of blue and can pose accessibility challenges.

You can take that or leave it, but none of us are web design experts so I would tend to defer to the default non-controversial colors in the standard theme. So that would imply changing the astropy.org theme colors rather than the docs.astropy.org theme colors to be fully unified.

Cadair commented May 12, 2026
edited
Loading

Copy link
Copy Markdown
Member Author

I think there's some context missing here. When I say we shouldn't hold up this PR, I mean because the colours are not defined in this repo (they are in astropy-sphinx-theme) and I don't want to hold up the 8.0 release process. We can release a new version of astropy-sphinx-theme and rebuild the RTD builds and the colours will be updated with no PRs to this repo at all. Also any changes to the theme will be reflected in all repos, website included.

I don't actually care what the colours for the theme are, I asked for feedback on the theme pushing 4 months ago. I've opened a PR which resets the link colours in the body of the pages to the pydata-sphinx-theme colours here: astropy/astropy-sphinx-theme#58

Copy link
Copy Markdown
Member

@Cadair - thanks for the clarification, that makes sense. So I would endorse merging this PR contingent upon agreement (in principle) to change the astropy-sphinx-theme prior to the 8.0 release.

I'll confess that the unusual orange links in the astropy.org site had not previously caught my eye. This is partly because some of the links on the first landing page are actually in the call-to-action category, and partly because I just don't use that site nearly as much and it simply escaped my attention.

I do care about colors and also believe that adhering to almost universally-adopted web standards is important.

Cadair commented May 12, 2026

Copy link
Copy Markdown
Member Author

contingent upon agreement (in principle) to change the astropy-sphinx-theme

I have no issues with changing things, but basically so far only ~4 people have reviewed the theme. 🤷

pllim commented May 12, 2026

Copy link
Copy Markdown
Member

Maybe it is better to re-milestone this to v8.1 so we have time do make such discussions and not rush things into production?

Cadair commented May 12, 2026
edited
Loading

Copy link
Copy Markdown
Member Author

It's already in production, ccdproc just merged it, the website has merged it. We can change the theme settings without any issues. I see no reason to delay this, but you all do what you want.

Comment thread docs/conf.py Outdated

astrofrog 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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I think we should merge this in now and then move the discussion to the theme repo to adjust the link colours. People have been on board with this theme and we have already decided to start the migration. We can easily adjust the link color in the theme this week and have it sorted before the final 8.0 release.

In the interest of minimising changes here after the imminent 8.0.0b1 release, I am going to go ahead and merge and we should then continue discussing link colors on the theme PR.

Copy link
Copy Markdown
Member

And to be explicit, I am happy to agree to merging the theme PR to update the link colors.

astrofrog merged commit ed35a5d into astropy:main May 12, 2026
39 checks passed

taldcroft commented May 12, 2026
edited
Loading

Copy link
Copy Markdown
Member

👍 on merging now for 8.0.

astrofrog added a commit that referenced this pull request May 12, 2026
…206-on-v8.0.x

Backport PR #19206 on branch v8.0.x (Migrate documentation to new unified astropy sphinx theme)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

DOC: Use Astropy orange in pydata-sphinx-theme Common navigation in the website of scipy projects

4 participants


Back | FazBrowse Home | New Git URL