Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ensure repo checkout is unshallow in RTD builds for SCM versioning #2019

Merged
merged 1 commit into from
Jul 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,17 @@
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3"
jobs:
post_checkout:
# RTD defaults to a depth of 50 but Toga versioning may require
# much more git history to accurately determine the SCM version
- git fetch --unshallow
pre_build:
- tox -e docs-lint

Expand All @@ -24,11 +26,11 @@ sphinx:
formats:
- pdf

# Python requirements required to build your docs
# Install extras for build - dev is needed to run tox
python:
install:
- method: pip
path: core
extra_requirements:
- docs
- dev
- docs
1 change: 1 addition & 0 deletions changes/2019.misc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The Toga repository checkout for Read the Docs builds is now made unshallow to ensure accurate SCM versioning.