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

Major documentation theme update and fixes #1676

Merged
merged 12 commits into from
Jan 16, 2025
Merged

Conversation

omad
Copy link
Member

@omad omad commented Dec 3, 2024

Reason for this pull request

  • Major update to the documentation theme
  • Upgrade the version of pydata-sphinx-theme
  • Amazingly better display on mobile devices/narrow viewports
  • Dark mode
  • Fixed 180 odd Sphinx Warnings, including rendering issues, missing links, etc.
  • Removed the old custom CSS for sidebar nav, since it's now built in.
  • Removed the custom HTML mangling code for doing sidebar nav
  • Add syntax highlighting for notebook cells used to render the docs
  • Renamed the Top Level Nav pages
  • Added the Top Level Nav items to the front page of the docs in a grid from sphinx-design

📚 Documentation preview 📚: https://datacube-core--1676.org.readthedocs.build/en/1676/

@omad omad force-pushed the dra/docs-theme-updates branch 3 times, most recently from 7a8bad8 to abb3bb8 Compare December 3, 2024 01:36
@omad omad force-pushed the dra/docs-theme-updates branch from f83b35b to 6bdf003 Compare December 12, 2024 00:36
@omad omad force-pushed the dra/docs-theme-updates branch 4 times, most recently from 60f8dc0 to 260781d Compare January 15, 2025 05:29
@omad omad changed the base branch from develop-1.9 to develop January 15, 2025 05:39
@omad omad force-pushed the dra/docs-theme-updates branch from a9b3c64 to efee902 Compare January 15, 2025 05:42
@omad omad changed the title Docs theme updates Major documentation theme update and fixes Jan 15, 2025
@omad omad marked this pull request as ready for review January 15, 2025 06:01
@omad omad force-pushed the dra/docs-theme-updates branch from 5746fd5 to 99d3c55 Compare January 15, 2025 06:06
@omad omad force-pushed the dra/docs-theme-updates branch from 99d3c55 to 355f439 Compare January 15, 2025 06:06
@omad omad requested review from caitlinadams, Ariana-B and SpacemanPaul and removed request for caitlinadams January 15, 2025 06:08
@omad omad force-pushed the dra/docs-theme-updates branch from 355f439 to de58dbc Compare January 15, 2025 06:16
Copy link

codecov bot commented Jan 15, 2025

Codecov Report

Attention: Patch coverage is 69.38776% with 45 lines in your changes missing coverage. Please review.

Project coverage is 85.64%. Comparing base (62d7cb6) to head (de58dbc).
Report is 16 commits behind head on develop.

Files with missing lines Patch % Lines
datacube/api/core.py 79.09% 23 Missing ⚠️
datacube/utils/geometry/gbox.py 16.00% 21 Missing ⚠️
datacube/cfg/api.py 88.88% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #1676      +/-   ##
===========================================
- Coverage    85.64%   85.64%   -0.01%     
===========================================
  Files          151      151              
  Lines        15531    15530       -1     
===========================================
- Hits         13301    13300       -1     
  Misses        2230     2230              

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

Copy link
Contributor

@caitlinadams caitlinadams left a comment

Choose a reason for hiding this comment

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

This is great @omad! Thanks for working on it. I've tested the local build and it's working and looks much much better.

@omad omad merged commit 0bd488f into develop Jan 16, 2025
19 checks passed
@omad omad deleted the dra/docs-theme-updates branch January 16, 2025 21:57
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.

2 participants