Skip to content

Update the cookiecutter template and link to the source from the API - #50

Open
timtreis wants to merge 1 commit into
mainfrom
docs/tooling
Open

timtreis wants to merge 1 commit into
mainfrom
docs/tooling

Conversation

@timtreis

@timtreis timtreis commented Sep 17, 2026

Copy link
Copy Markdown
Member

Two small tooling changes, no notebooks and no source.

cruft update to e6f473c. Its one change is build.targets.sdist.exclude = [ "/docs", "/tests" ],
applied by hand because the hunk rejected against our diverged dependency groups. The sdist drops
from 2.3 MB over 189 entries to 176 kB over 106 — it no longer ships the test suite or the notebooks
with their committed outputs. cruft check passes.

sphinx.ext.viewcode adds a source link to every API entry. The template does not enable it;
cookiecutter-scverse#103 tracks the same gap upstream for linkcode.

Part of #23. Relevant to #36.

cruft update brings the template to e6f473c, whose one change is
`build.targets.sdist.exclude`. Applied by hand: the hunk rejected because the
dependency groups around it have diverged. The sdist goes from 2.3 MB over 189
entries to 176 kB over 106, since it no longer ships the test suite or the
notebooks with their committed outputs. Worth having before the first release.

`sphinx.ext.viewcode` puts a source link on every entry in the API reference.
The template does not enable it yet; cookiecutter-scverse#103 tracks the same
gap upstream for linkcode.

Part of #23. Skipped sphinx_issues from that issue for now: nothing in the
changelog or the docs refers to an issue by number, so it would be a dependency
and a config line for no links.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LUprSEAYStTMX3dzrHXLes
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.70%. Comparing base (9501cdd) to head (3379f5a).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #50   +/-   ##
=======================================
  Coverage   90.70%   90.70%           
=======================================
  Files          76       76           
  Lines        5175     5175           
=======================================
  Hits         4694     4694           
  Misses        481      481           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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