Skip to content

Replace sphinx-tabs with sphinx-design#138

Merged
ColmTalbot merged 2 commits intomainfrom
copilot/switch-sphinx-tabs-to-design
Feb 15, 2026
Merged

Replace sphinx-tabs with sphinx-design#138
ColmTalbot merged 2 commits intomainfrom
copilot/switch-sphinx-tabs-to-design

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Feb 15, 2026

sphinx-tabs is incompatible with recent Sphinx versions, causing documentation build failures. sphinx-design provides equivalent functionality and was already installed.

Changes

  • pages_requirements.txt: Removed sphinx-tabs dependency
  • docs/conf.py: Removed sphinx_tabs.tabs extension
  • docs/guide/installation.rst: Updated tab directive syntax

Syntax Migration

-.. tabs::
+.. tab-set::

-   .. tab:: Conda
+   .. tab-item:: Conda

       .. code-block:: console

          $ conda install -c conda-forge gwpopulation

All tab functionality remains identical; only the directive names changed.

Original prompt

The documentation building job has started failing because sphinx tabs is not compatible with recent versions of sphinx. Tabs can now be specified using sphinx-design. Switch all uses of sphinx-tabs to use sphinx-design instead.


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: ColmTalbot <25602909+ColmTalbot@users.noreply.github.com>
Copilot AI changed the title [WIP] Replace sphinx-tabs with sphinx-design in documentation Replace sphinx-tabs with sphinx-design Feb 15, 2026
Copilot AI requested a review from ColmTalbot February 15, 2026 22:35
Copy link
Copy Markdown
Owner

@ColmTalbot ColmTalbot left a comment

Choose a reason for hiding this comment

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

Looks good to me assuming the docs job passes.

@codecov
Copy link
Copy Markdown

codecov bot commented Feb 15, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.15%. Comparing base (5054826) to head (3157e2e).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #138   +/-   ##
=======================================
  Coverage   95.15%   95.15%           
=======================================
  Files          14       14           
  Lines         907      907           
=======================================
  Hits          863      863           
  Misses         44       44           
Flag Coverage Δ
python3.10 95.15% <ø> (ø)
python3.11 95.15% <ø> (ø)
python3.12 95.15% <ø> (ø)
python3.13 95.15% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ColmTalbot ColmTalbot marked this pull request as ready for review February 15, 2026 22:48
@ColmTalbot ColmTalbot merged commit ce9af49 into main Feb 15, 2026
9 checks passed
@ColmTalbot ColmTalbot deleted the copilot/switch-sphinx-tabs-to-design branch February 15, 2026 22:48
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