Skip to content

Use default font for headings and body text #183

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

Merged
merged 3 commits into from
Mar 2, 2025

Conversation

willingc
Copy link
Contributor

@willingc willingc commented Feb 26, 2025

This PR uses the default pydata sphinx theme font for body text and headings.and leaves barlow for heading.

Addresses #88.

2025-02-27 docs workgroup meeting agreed that removing Barlow made sense. If needed, we can revisit the fonts in a future issue/PR.

This PR uses the default pydata sphinx theme font for body text and leaves barlow for heading
@willingc
Copy link
Contributor Author

Screenshot 2025-02-26 at 11 14 40 AM
Screenshot 2025-02-26 at 11 14 52 AM
Screenshot 2025-02-26 at 11 15 06 AM

@willingc
Copy link
Contributor Author

willingc commented Feb 26, 2025

If you wanted a commonly paired font with Barlow, this would be how the main test page looks with Roboto as text font.
Screenshot 2025-02-26 at 11 35 22 AM

IMHO I think the default provides the best readability.

@willingc willingc changed the title Use default font for body text Use default font for headings and body text Feb 27, 2025
@willingc
Copy link
Contributor Author

@DragaDoncila @psobolewskiPhD @melissawm For your review.

@DragaDoncila
Copy link
Contributor

Hmm CI is not happy 🥹

@willingc
Copy link
Contributor Author

Blah, these unrelated to the PR seg faults concern me. @DragaDoncila can you restart the CI (I don't have sufficient permissions) to see if this is an intermittent seg fault or reproducible seg fault.

@willingc
Copy link
Contributor Author

As an aside, I don't think it is necessary to run a complete build of the docs for every theme change. I think for most cases a representative set of pages would suffice.

@DragaDoncila
Copy link
Contributor

@willingc re-ran!

@psobolewskiPhD
Copy link
Member

CI here needs to be updated for the changes in napari/docs and napari/napari.

As an aside, I don't think it is necessary to run a complete build of the docs for every theme change. I think for most cases a representative set of pages would suffice.

Really good point. I put together the full build when we were first testing things with the theme and a new version of the upstream theme. But now that we arn't tinkering much, we could safely drop stuff -- like the gallery.

@willingc
Copy link
Contributor Author

Seg faulted again but in a different place. I think that we still need to work through the seg faults but I don't think this is the repo to do that. I would prefer napari/napari to be the place to do so or possibly napari/docs as well. If it is ok with you, I can put up a PR in the morning to swap the workflow to building the example docs.

@psobolewskiPhD
Copy link
Member

could also be the tensorstore constraints issue Grzegorz mentioned. lets see if my new PR passes.

@psobolewskiPhD
Copy link
Member

@DragaDoncila @willingc The build passes when updated for the latest changes to the docs dependencies (just like napari/docs and napari/napari):
#186
I also used html-noplot to make it quicker.

@DragaDoncila
Copy link
Contributor

I optimistically merged #186 and will merge into here to see if that works.

Copy link
Contributor

@DragaDoncila DragaDoncila left a comment

Choose a reason for hiding this comment

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

CI is green now yay 🎉 and I've had a scroll through different pages like the API ref, pages with lots of code and text pages, and this all looks good to me. Thanks @willingc ❤️

@TimMonko
Copy link

@psobolewskiPhD why 0.7 milestone?

@psobolewskiPhD
Copy link
Member

@TimMonko we will need a release of this theme in order for it to be used by napari/docs.
(which also means we will need the constraints in napari/napari to be updated to allow it!)

@willingc
Copy link
Contributor Author

willingc commented Mar 1, 2025

@psobolewskiPhD A release of this theme shouldn't be difficult. Looking at the code in napari/napari, there are only 2 places where the config/constraints list napari-sphinx-theme (pyproject.toml and the docs constraints file). I'm not sure that all the constraints files need to be regenerated to use the theme. Thoughts?

@psobolewskiPhD
Copy link
Member

psobolewskiPhD commented Mar 1, 2025

I didn't mean to imply it was difficult, but a release of the theme and then a PR to update of constraints does need to be done to see the effect of any PRs to the theme.

@TimMonko
Copy link

TimMonko commented Mar 2, 2025

I think me (and maybe @willingc ) assumed the 0.7 was tagged to the napari release milestone, but I've realized this is probably the sphinx theme milestone. Didn't realize the theme was a confusingly-close-to-napari 0.6.0

@psobolewskiPhD
Copy link
Member

Oh, sorry! My b!
Yeah, exactly: 0.7.0 milestone is next theme release.

@psobolewskiPhD psobolewskiPhD merged commit 326a0d5 into napari:main Mar 2, 2025
1 check passed
@psobolewskiPhD psobolewskiPhD mentioned this pull request Mar 2, 2025
@willingc willingc deleted the patch-1 branch March 2, 2025 04:43
@willingc
Copy link
Contributor Author

willingc commented Mar 2, 2025

Thanks @psobolewskiPhD. Yep, I totally thought we were discussing the napari release. All good. TYVM, @TimMonko Thanks for clarifying too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants