Skip to content

Update sphinx configuration to use new astropy-unified theme#3590

Open
Cadair wants to merge 4 commits into
astropy:mainfrom
Cadair:sphinx-unified-theme
Open

Update sphinx configuration to use new astropy-unified theme#3590
Cadair wants to merge 4 commits into
astropy:mainfrom
Cadair:sphinx-unified-theme

Conversation

@Cadair
Copy link
Copy Markdown
Member

@Cadair Cadair commented May 12, 2026

This PR migrates this repo to use the new astropy-unified sphinx theme.

For more information about this project see astropy/astropy-project#522

@Cadair Cadair marked this pull request as draft May 12, 2026 12:50
@codecov
Copy link
Copy Markdown

codecov Bot commented May 12, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.23%. Comparing base (e3702c4) to head (0ae71d3).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3590   +/-   ##
=======================================
  Coverage   73.22%   73.23%           
=======================================
  Files         226      226           
  Lines       21000    21010   +10     
=======================================
+ Hits        15378    15386    +8     
- Misses       5622     5624    +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Cadair Cadair marked this pull request as ready for review May 12, 2026 14:32
@bsipocz bsipocz added this to the 0.4.12 milestone May 12, 2026
bsipocz
bsipocz previously approved these changes May 12, 2026
Copy link
Copy Markdown
Member

@bsipocz bsipocz left a comment

Choose a reason for hiding this comment

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

Thanks @Cadair, this is long overdue!

@keflavich - I hold off merging to give you a chance to have a look, but overall I would say we merge and fix in follow-up if any issue pops up

Copy link
Copy Markdown
Contributor

@keflavich keflavich left a comment

Choose a reason for hiding this comment

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

I see a red diff and green CI, I approve!

I think this looks good, but can we see how it renders? Is the title preserved?

html_theme_options = {
'logotext1': 'astro', # white, semi-bold
'logotext2': 'query', # orange, light
'logotext3': ':docs', # white, light
}

Image

@Cadair
Copy link
Copy Markdown
Member Author

Cadair commented May 12, 2026

Build preview is on the RTD status check here: https://astroquery--3590.org.readthedocs.build/en/3590/

That logo customisation isn't in the new theme. We could add a svg of it to the logo spot in the sidebar?

@bsipocz
Copy link
Copy Markdown
Member

bsipocz commented May 12, 2026

ahh, this reminds me to circle back to the actual logo question. As for the colouring, I would agree that it would be nice to keep the customization even if it's just via an svg; the current theme is very very much astropy and I don't actually want to loose the branding of astroquery.

@bsipocz
Copy link
Copy Markdown
Member

bsipocz commented May 12, 2026

(I don't mind the top bar, but actually do mind that it only says astropy )

@keflavich
Copy link
Copy Markdown
Contributor

ditto, I'd like to keep astroquery branding, so please hold off on merging this until we have created the svg logo. Can we do that trivially from the old theme?

@bsipocz bsipocz dismissed their stale review May 13, 2026 01:56

we agreed to do some tweaks before merging, so I'm flipping this status to red to make sure we don't accidentally merge.

Copy link
Copy Markdown
Member

@bsipocz bsipocz left a comment

Choose a reason for hiding this comment

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

OK, let's hold off until we figure out how to make the astroquery branding more prominent than the top level heading's astropy one.

@Cadair
Copy link
Copy Markdown
Member Author

Cadair commented May 13, 2026

We could do something like this on photutils:

image

Put a logo up on the left sidebar?

@keflavich
Copy link
Copy Markdown
Contributor

can try this. If it works, where do we put it?

<?xml version="1.0" encoding="UTF-8"?>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 340 60" role="img" aria-label="astroquery:docs">
  <title>astroquery:docs</title>
  <style>
    .logo { font-family: 'Lato', -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', Arial, sans-serif; font-size: 44px; }
    .a1 { font-weight: 600; fill: currentColor; }
    .a2 { font-weight: 300; fill: #EC5810; }
    .a3 { font-weight: 300; fill: currentColor; }
  </style>
  <text x="0" y="46" class="logo"><tspan class="a1">astro</tspan><tspan class="a2">query</tspan><tspan class="a3">:docs</tspan></text>
</svg>

Putting the logo below is... fine, I guess? But I like the docs as they are now, I don't like arbitrary change.

@keflavich
Copy link
Copy Markdown
Contributor

(I haven't played with the above at all; the font families are just ai-gen, but they're close to what we have now: "Lato", "proxima-nova", "Helvetica Neue", "Arial", sans-serif;. I don't know if the mac stuff is relevant)

@Cadair
Copy link
Copy Markdown
Member Author

Cadair commented May 13, 2026

Do you want to keep the :docs or do you want to make a more general astroquery logo? I can probably easily edit the astropy svgs to make whatever we want.

@Cadair
Copy link
Copy Markdown
Member Author

Cadair commented May 13, 2026

Here's one on a dark background, but I could make a dark and a light variant?

astropyquery_light

@keflavich
Copy link
Copy Markdown
Contributor

the last thing you posted is good - if we can have that sitting in the top left, I'm happy enough, I spose.

@Cadair
Copy link
Copy Markdown
Member Author

Cadair commented May 13, 2026

Ok, see last commit. I added it to the top of the index page as well.

@keflavich
Copy link
Copy Markdown
Contributor

https://astroquery--3590.org.readthedocs.build/en/3590/

Thanks for adding that @Cadair . I still don't love the aesthetics right now.... there's redundant labeling all around. I like astroquery's current more minimal look.

new:
image
current:
image

@Cadair
Copy link
Copy Markdown
Member Author

Cadair commented May 13, 2026

oh man, you don't have the font for that logo installed 🙈 I should add it to the CSS. It is included in the CSS, so why isn't it using it for the svg??

So remove it from the index page and just leave it in the sidebar?

@keflavich
Copy link
Copy Markdown
Contributor

So remove it from the index page and just leave it in the sidebar?

yeah I think so

argh, fonts.

@Cadair
Copy link
Copy Markdown
Member Author

Cadair commented May 13, 2026

How about now? I don't know what's up with the fonts?

@bsipocz
Copy link
Copy Markdown
Member

bsipocz commented May 13, 2026

I like astroquery's current more minimal look.

unfortunately we'll need to move on from that, we even have a (or more) many years old issue(s) for that. At some point Clara was about to change stuff but she also went nuclear with mixing theme changes with content rather than doing piecemeal so it couldn't be merged.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants