Skip to content

Fix docs build: TensorKitSectors doctests, re-export NamedSector - #566

Open
lkdvos wants to merge 2 commits into
mainfrom
ld-docfail
Open

lkdvos wants to merge 2 commits into
mainfrom
ld-docfail

Conversation

@lkdvos

@lkdvos lkdvos commented Oct 2, 2026

Copy link
Copy Markdown
Member

The documentation build fails on recent PRs (e.g. #565) because TensorKitSectors v0.3.10 added doctests for NamedSector/@NamedSector. Since TensorKitSectors is in makedocs' modules, its docstrings get doctested here too, but only TensorKit had a DocTestSetup and TensorKit did not re-export NamedSector.

Changes:

  • Set a DocTestSetup of using TensorKitSectors for TensorKitSectors docstrings
  • Add TensorKitSectors as an explicit docs dependency
  • Re-export NamedSector and @NamedSector, bump TensorKitSectors compat to 0.3.10, and add them to the sectors library page
  • Changelog entries

Docs build passes locally.

🤖 Generated with Claude Code

lkdvos and others added 2 commits October 2, 2026 12:51
TensorKitSectors v0.3.10 added doctests for `NamedSector`, which TensorKit does
not re-export, so they failed when doctested as part of `modules`.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@lkdvos
lkdvos requested a review from kshyatt October 2, 2026 18:24
@codecov

codecov Bot commented Oct 3, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Files with missing lines Coverage Δ
src/TensorKit.jl 17.24% <ø> (ø)

... and 21 files with indirect coverage changes

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

This branch has not been deployed

No deployments
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.

1 participant