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

Change the documentation theme to Furo #244

Merged
merged 4 commits into from
Jul 7, 2024
Merged

Change the documentation theme to Furo #244

merged 4 commits into from
Jul 7, 2024

Conversation

jstasiak
Copy link
Collaborator

The default one feels a bit outdated to me, let's try this[1].

I initially wanted to go with the RTD theme but it doesn't support dark mode natively[2].

The theme is used in Python Developer's Guide[3] and it looks nice in my opinion.

[1] https://github.com/pradyunsg/furo#elevator-pitch
[2] readthedocs/sphinx_rtd_theme#224
[3] https://devguide.python.org/

The default one feels a bit outdated to me, let's try this[1].

I initially wanted to go with the RTD theme but it doesn't
support dark mode natively[2].

The theme is used in Python Developer's Guide[3] and it looks
nice in my opinion.

[1] https://github.com/pradyunsg/furo#elevator-pitch
[2] readthedocs/sphinx_rtd_theme#224
[3] https://devguide.python.org/
@codecov-commenter
Copy link

codecov-commenter commented Dec 13, 2023

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.22%. Comparing base (78bb621) to head (ad625d5).
Report is 7 commits behind head on master.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #244   +/-   ##
=======================================
  Coverage   95.22%   95.22%           
=======================================
  Files           1        1           
  Lines         565      565           
  Branches       96       96           
=======================================
  Hits          538      538           
  Misses         20       20           
  Partials        7        7           

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

@jstasiak
Copy link
Collaborator Author

@jstasiak
Copy link
Collaborator Author

jstasiak commented Dec 13, 2023

One blocker (the localtoc.html issue): https://injector--244.org.readthedocs.build/en/244/changelog.html

Screenshot 2023-12-13 at 23 25 42

Leaving this for later

@jstasiak jstasiak merged commit f3a0c6e into master Jul 7, 2024
9 checks passed
@jstasiak jstasiak deleted the furo-theme branch July 7, 2024 22:41
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