Add New Astropy Theme by Cadair · Pull Request #48 · astropy/astropy-sphinx-theme

Cadair · 2026-01-21T13:56:49Z

This PR adds the new theme.

You can see built documentation with this theme in the following places:

https://astropy-org-test.readthedocs.io/ - astropy.org home page.
https://reproject--581.org.readthedocs.build/en/581/ - reproject.
https://astropy--19206.org.readthedocs.build/en/19206/ - astropy core.

Cadair · 2026-01-21T16:04:02Z

astropy_sphinx_theme/astropy-unified/theme.toml

+        ]
+    ],
+    ["Documentation",
+        [


At the moment I have just linked the coordinated packages here. We need to decide if we want to list all affiliated packages or not.

As you can see on https://sunpy.org it's possible to have collapsible sections here, so we could choose to put all the affiliated packages under a click to reveal list.

It should also be noted that by default if we list all the affiliated packages here they will also be included in the unified search results (as long as they are hosted on RTD).

Cadair · 2026-01-21T16:04:57Z

astropy_sphinx_theme/astropy-unified/theme.toml

+    ["Team", "team.html", 2],
+]
+rtd_extra_search_projects = [["astropy-org-test", "https://astropy-org-test.readthedocs.io"]]
+footer_links = [["Code of Conduct", "code_of_conduct.html", 2]]


At the moment I have only put the CoC in the footer.

The footer on astropy.org is quite different before this theme so we might want to customize the footer further.

bsipocz · 2026-01-21T17:12:39Z

This PR adds the new theme, it is built on top of #47 actual diff is here

If you make the base branch the #47 then it all cleans up here, and once that one is merged will be fall back on main. It's a rather nice and convenient recent(ish) GH feature.

Cadair · 2026-01-21T17:15:38Z

I didn't realise you could do that unless the base branch was on the upstream repo. I'll have a look!

bsipocz · 2026-01-21T17:18:23Z

I didn't realise you could do that unless the base branch was on the upstream repo

Ah, maybe you are right and we could only do that as I cannot convince my team to use fork-based development 🙄

This brings it closer to astropy#48 as well

Cadair · 2026-01-22T10:51:35Z

astropy_sphinx_theme/astropy-unified/theme.toml

+            ["specreduce", "https://specreduce.readthedocs.io", 3],
+            ["specutils", "https://specutils.readthedocs.io", 3],
+        ]
+    ],


docs.astropy.org has a learn link in the header, would we like to add one here?

Cadair · 2026-01-22T14:38:46Z

(The CI is failing because of GitHub flakiness)

astrofrog · 2026-01-22T14:54:12Z

pyproject.toml

-dependencies = ["sphinx>6"]
+dependencies = [
+    "sphinx>6",
+    "sunpy-sphinx-theme@git+https://github.com/sunpy/sunpy-sphinx-theme",


So just to check, what is required here? Are there some unreleased changes in the sunpy sphinx theme?

yes, I keep finding bugs or things to tweak while doing this so I'm stalling on releasing the sunpy theme till I've found ~~them all~~ more of them.

"found them all"

Wow, that level of optimism 🤣 (I see the correction, yet :) )

Did sunpy-sphinx-theme get new release yet? I don't think we can merge until the theme is out.

I don't think we are close to merging this 😜

pllim · 2026-01-22T22:45:02Z

For the astropy core, the upper banner gets confusing for me. Say, I am in "latest" (dev version doc) and then I click this:

And suddenly I am in stable doc. If I am not careful, I would think I am still in "latest" and then chaos ensues.

pllim · 2026-01-22T22:46:15Z

Also it's way too much orange even though Erik T would probably like it given astropy/astropy#15111

mhvk · 2026-01-23T16:32:06Z

Just a quick note that I find the new theme quite pleasant -- but then, I've grown up in NL so like the colour orange ...

Cadair · 2026-01-23T18:34:04Z

For the astropy core, the upper banner gets confusing for me. Say, I am in "latest" (dev version doc) and then I click this:

I don't think there's an easy way to fix this problem and it doesn't seem to me that it's going to be a big problem?

pllim · 2026-01-23T18:58:14Z

big problem

Maybe I am outlier but I work with astropy almost exclusively in the dev version, and I confused myself in the first few mins navigating that menu.

Cadair · 2026-01-24T09:25:43Z

That's really interesting to me, I'd never use that menu to get back to the documentation homepage, but now you've said it I can see people doing it. For what it's worth nobody has ever complained about doing this with the sunpy docs 🤷

I've opened this: sunpy/sunpy-sphinx-theme#308 I hope you don't consider this a blocking issue 🙈

Cadair · 2026-01-24T09:27:58Z

Also it's way too much orange

In that there's too many occurrences of the colour orange or that the orange is too orange? Also light theme or dark? I haven't put a lot of effort into the colouring yet, so I'm happy to tweak things some. However, I also don't have a load of time to prod around with CSS if I want to get this rolled out to all the packages within budget.

pllim · 2026-01-26T19:01:46Z

sunpy/sunpy-sphinx-theme#308

Thanks! I don't think it is blocking.

orange

Also non-blocking. Just an observation. Marten seems happy with it.

neutrinoceros · 2026-03-04T14:19:41Z

this looks great. I love the improved discoverability !

Cadair force-pushed the sunpy-astropy-theme branch 2 times, most recently from e298042 to 89bcf77 Compare January 21, 2026 14:01

This was referenced Jan 21, 2026

Rewrite to a sphinx project and use unified theme astropy/astropy.github.com#698

Open

WIP: Add an astropy theme which is a re-configured sunpy-sphinx-theme astropy/sphinx-astropy#93

Closed

Cadair force-pushed the sunpy-astropy-theme branch from d6e14f5 to 72ed121 Compare January 21, 2026 15:11

Cadair mentioned this pull request Jan 21, 2026

Tracking Issue: Unified Astropy Sphinx Theme Migration astropy/astropy-project#522

Open

Cadair commented Jan 21, 2026

View reviewed changes

Cadair force-pushed the sunpy-astropy-theme branch from 85a6026 to 60c11e5 Compare January 21, 2026 16:29

Cadair mentioned this pull request Jan 21, 2026

Repo Cleanup #47

Merged

3 tasks

Cadair added a commit to Cadair/astropy-sphinx-theme that referenced this pull request Jan 22, 2026

Fix CircleCI build

9dae9cf

This brings it closer to astropy#48 as well

Cadair force-pushed the sunpy-astropy-theme branch 3 times, most recently from 4a43cd6 to e35f7e4 Compare January 22, 2026 10:09

Cadair commented Jan 22, 2026

View reviewed changes

Cadair added 7 commits January 22, 2026 14:28

Add second theme

2f82375

dep on sunpy theme

b4dbfca

Default some more stuff for new theme

ea83e4c

TMP: use build preview for main site

82d1496

Add CoC to footer

6b1b595

Deprecate old function

9ec3869

wtaf

e71c421

Cadair force-pushed the sunpy-astropy-theme branch from e35f7e4 to e71c421 Compare January 22, 2026 14:29

Cadair added 2 commits January 22, 2026 14:33

Update circleci status job

65ee549

more pre-commit

482da03

Cadair marked this pull request as ready for review January 22, 2026 15:03

Cadair mentioned this pull request Jan 22, 2026

Test out new unified theme astropy/astropy#19206

Draft

1 task

astrofrog reviewed Jan 22, 2026

View reviewed changes

Cadair mentioned this pull request Jan 24, 2026

Have a way of linking to the current version of a documentation page in the topnav bar sunpy/sunpy-sphinx-theme#308

Open

Uh oh!

Conversation

Cadair commented Jan 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bsipocz commented Jan 21, 2026

Uh oh!

Cadair commented Jan 21, 2026

Uh oh!

bsipocz commented Jan 21, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Cadair commented Jan 22, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bsipocz Jan 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pllim commented Jan 22, 2026

Uh oh!

pllim commented Jan 22, 2026

Uh oh!

mhvk commented Jan 23, 2026

Uh oh!

Cadair commented Jan 23, 2026

Uh oh!

pllim commented Jan 23, 2026

Uh oh!

Cadair commented Jan 24, 2026

Uh oh!

Cadair commented Jan 24, 2026

Uh oh!

pllim commented Jan 26, 2026

Uh oh!

neutrinoceros commented Mar 4, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Cadair commented Jan 21, 2026 •

edited

Loading

bsipocz Jan 22, 2026 •

edited

Loading