Skip to content

Show the released version in the docs instead of "0+untagged" - #1926

Merged
CodyCBakerPhD merged 1 commit into
dandi:masterfrom
kabilar:fix-rtd-docs-version
Sep 21, 2026
Merged

CodyCBakerPhD merged 1 commit into
dandi:masterfrom
kabilar:fix-rtd-docs-version

Conversation

@kabilar

@kabilar kabilar commented Sep 21, 2026

Copy link
Copy Markdown
Member

Context

The DANDI Client Read the Docs shows the 0+untagged.353.gd92c917 version:

image

Here I propose changing this value to the latest version on PyPI.

Changes

  • Fetch the history and tags in a post_checkout job, before pip install . runs versioneer.
  • Strip the local version segment for display. version is now the released portion (e.g. 0.80.0), and html_title uses version since Sphinx's default builds that title from release.

Read the Docs clones shallowly and fetches only the branch ref, so the
build had no tags for versioneer to describe and `dandi.__version__` fell
back to "0+untagged.353.gd92c917".  Fetch the history and tags in a
post_checkout job, before `pip install .` runs versioneer.

Also strip the local version segment for display: `version` is now the
released portion (e.g. "0.80.0") while `release` keeps the full
commit-precise string, and `html_title` uses `version` since Sphinx's
default builds that title from `release`.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@kabilar
kabilar requested a review from yarikoptic September 21, 2026 20:04
@kabilar kabilar self-assigned this Sep 21, 2026
@kabilar kabilar added documentation Changes only affect the documentation patch Increment the patch version when merged labels Sep 21, 2026
@codecov

codecov Bot commented Sep 21, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.12%. Comparing base (d92c917) to head (9712432).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1926      +/-   ##
==========================================
- Coverage   78.14%   78.12%   -0.02%     
==========================================
  Files          91       91              
  Lines       13944    13944              
==========================================
- Hits        10896    10894       -2     
- Misses       3048     3050       +2     
Flag Coverage Δ
unittests 78.12% <ø> (-0.02%) ⬇️

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

☔ View full report in Codecov by Harness.
📢 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.

@CodyCBakerPhD

Copy link
Copy Markdown
Contributor

yikes

thanks for fix

image

^ current docs, looking not-so-good

@CodyCBakerPhD
CodyCBakerPhD merged commit e88467d into dandi:master Sep 21, 2026
65 of 67 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Changes only affect the documentation patch Increment the patch version when merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants