Skip to content
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

DOC: Fix logos and dark mode #3245

Merged
merged 1 commit into from
Oct 23, 2024
Merged

Conversation

pllim
Copy link
Contributor

@pllim pllim commented Oct 22, 2024

Description

This pull request is an alternate fix for the logos based on astropy/astropy#16639

Close #3243

Change log entry

  • Is a change log needed? If yes, is it added to CHANGES.rst? If you want to avoid merge conflicts,
    list the proposed change log here for review and add to CHANGES.rst before merge. If no, maintainer
    should add a no-changelog-entry-needed label.

Checklist for package maintainer(s)

This checklist is meant to remind the package maintainer(s) who will review this pull request of some common things to look for. This list is not exhaustive.

  • Are two approvals required? Branch protection rule does not check for the second approval. If a second approval is not necessary, please apply the trivial label.
  • Do the proposed changes actually accomplish desired goals? Also manually run the affected example notebooks, if necessary.
  • Do the proposed changes follow the STScI Style Guides?
  • Are tests added/updated as required? If so, do they follow the STScI Style Guides?
  • Are docs added/updated as required? If so, do they follow the STScI Style Guides?
  • Did the CI pass? If not, are the failures related?
  • Is a milestone set? Set this to bugfix milestone if this is a bug fix and needs to be released ASAP; otherwise, set this to the next major release milestone. Bugfix milestone also needs an accompanying backport label.
  • After merge, any internal documentations need updating (e.g., JIRA, Innerspace)?

@pllim pllim added bug Something isn't working trivial Only needs one approval instead of two 💤backport-v3.10.x on-merge: backport to v3.10.x backport-v4.0.x on-merge: backport to v4.0.x labels Oct 22, 2024
@pllim pllim added this to the 3.10.4 milestone Oct 22, 2024
@github-actions github-actions bot added the documentation Explanation of code and concepts label Oct 22, 2024
@pllim pllim added the no-changelog-entry-needed changelog bot directive label Oct 22, 2024
@pllim pllim marked this pull request as ready for review October 22, 2024 18:30
Copy link

codecov bot commented Oct 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.63%. Comparing base (f552510) to head (a19c09a).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3245   +/-   ##
=======================================
  Coverage   88.63%   88.63%           
=======================================
  Files         125      125           
  Lines       18779    18779           
=======================================
  Hits        16644    16644           
  Misses       2135     2135           

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

@haticekaratay
Copy link
Contributor

Hi @pllim,
Could you please add before and after screenshots demonstrating how the docs are built at the end? I'm asking because I'm currently testing it locally and wondering if this is what we expect to see in dark mode:
image

@pllim
Copy link
Contributor Author

pllim commented Oct 22, 2024

Hmm. I removed the "Note" part. Not sure why you see that locally.

Before: https://jdaviz.readthedocs.io/en/latest/

After: https://jdaviz--3245.org.readthedocs.build/en/3245/

@haticekaratay
Copy link
Contributor

Hmm. I removed the "Note" part. Not sure why you see that locally.

Before: https://jdaviz.readthedocs.io/en/latest/

After: https://jdaviz--3245.org.readthedocs.build/en/3245/

Yes. I realized that later. Thanks!

@haticekaratay
Copy link
Contributor

@pllim
One more question: Should we invert the colors of the logo in dark mode, or keep them as they are? @kecnry
image

@kecnry
Copy link
Member

kecnry commented Oct 22, 2024

iirc, the backgrounds are white, not transparent, so inverting was the best temporary solution. If we replace the logos with transparent backgrounds, then we can avoid inverting.

@pllim
Copy link
Contributor Author

pllim commented Oct 22, 2024

Should we invert the colors of the logo in dark mode

They were inverted on purpose (easier on the eyes and look better in dark mode). But we can un-invert if you want, though that is beyond fixing the layout.

Copy link
Contributor

@haticekaratay haticekaratay left a comment

Choose a reason for hiding this comment

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

Thanks!

@pllim pllim merged commit b47c128 into spacetelescope:main Oct 23, 2024
42 of 45 checks passed
@pllim pllim deleted the investigate-grid branch October 23, 2024 16:48

This comment was marked as resolved.

@pllim
Copy link
Contributor Author

pllim commented Oct 23, 2024

@haticekaratay , thanks for the review! I will let you handle your JIRA ticket for this as you see fit.

@pllim pllim modified the milestones: 3.10.4, 4.0.1 Oct 23, 2024
@pllim pllim removed the 💤backport-v3.10.x on-merge: backport to v3.10.x label Oct 23, 2024
@pllim
Copy link
Contributor Author

pllim commented Oct 23, 2024

Doc at 3.10.x actually not affected, so updated milestone. FYI.

pllim added a commit that referenced this pull request Oct 23, 2024
…5-on-v4.0.x

Backport PR #3245 on branch v4.0.x (DOC: Fix logos and dark mode)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-v4.0.x on-merge: backport to v4.0.x bug Something isn't working documentation Explanation of code and concepts no-changelog-entry-needed changelog bot directive trivial Only needs one approval instead of two
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants