Skip to content

Replacing sphinx-tabs with sphinx-design#706

Merged
davidorme merged 1 commit intodevelopfrom
705-remove-sphinx-tabs-and-use-sphinx-design
Jan 30, 2025
Merged

Replacing sphinx-tabs with sphinx-design#706
davidorme merged 1 commit intodevelopfrom
705-remove-sphinx-tabs-and-use-sphinx-design

Conversation

@davidorme
Copy link
Copy Markdown
Collaborator

@davidorme davidorme commented Jan 29, 2025

Description

@jacobcook1995 This is entirely trivial but we have two packages in our dev stack that provide the same functionality. We use sphinx-design for the nice cards and it also does tabs. This PR just subs sphinx-tabs out and duplicates the code tabs you added recently using sphinx-design.

The styling is very slightly different, but the functionality is the same.

image

Fixes #705

Type of change

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code) ◀️ Very very arguably 😄
  • Bug fix (non-breaking change which fixes an issue)

Key checklist

  • Make sure you've run the pre-commit checks: $ pre-commit run -a
  • All tests pass: $ poetry run pytest

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works
  • Relevant documentation reviewed and updated

@davidorme davidorme linked an issue Jan 29, 2025 that may be closed by this pull request
@codecov-commenter
Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.66%. Comparing base (bc8c2fa) to head (1124a54).
Report is 4 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #706   +/-   ##
========================================
  Coverage    94.66%   94.66%           
========================================
  Files           73       73           
  Lines         4833     4833           
========================================
  Hits          4575     4575           
  Misses         258      258           

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

Copy link
Copy Markdown
Collaborator

@jacobcook1995 jacobcook1995 left a comment

Choose a reason for hiding this comment

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

LGTM!

@davidorme davidorme merged commit 84a3ee3 into develop Jan 30, 2025
@davidorme davidorme deleted the 705-remove-sphinx-tabs-and-use-sphinx-design branch January 30, 2025 10:17
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.

Remove sphinx-tabs and use sphinx-design

3 participants