Skip to content

RTD unshallow clone#181

Merged
sandorkertesz merged 1 commit into
mainfrom
feature/rtd-unshallow-clone
Jun 29, 2026
Merged

RTD unshallow clone#181
sandorkertesz merged 1 commit into
mainfrom
feature/rtd-unshallow-clone

Conversation

@sandorkertesz

Copy link
Copy Markdown
Collaborator

Description

ssue with docs where version is wrong because setuptools_scm cannot find the tags because the clone is shallow. This PR should make the clone no longer shallow, and hence fix the issue

From rtd docs:

Read the Docs does not perform a full clone in the checkout job in order to reduce network data and speed up the build process. Instead, it performs a shallow clone and only fetches the branch or tag that you are building documentation for. Because of this, extensions that depend on the full Git history will fail. To avoid this, it’s possible to unshallow the git clone:

.readthedocs.yaml
version: 2
build:
os: "ubuntu-24.04"
tools:
   python: "3.10"
jobs:
   post_checkout:
     - git fetch --unshallow || true

Contributor Declaration

By opening this pull request, I affirm the following:

  • All authors agree to the Contributor License Agreement.
  • The code follows the project's coding standards.
  • I have performed self-review and added comments where needed.
  • I have added or updated tests to verify that my changes are effective and functional.
  • I have run all existing tests and confirmed they pass.

@sandorkertesz sandorkertesz merged commit b9dbbfd into main Jun 29, 2026
4 checks passed
@sandorkertesz sandorkertesz deleted the feature/rtd-unshallow-clone branch June 29, 2026 15:11
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