Update RTD config #1591
Merged
Update RTD config #1591
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
RTD "latest" (dev) builds show a wrong version number because they perform a shallow clone (depth 50) of the repo (https://docs.readthedocs.io/en/stable/build-customization.html#unshallow-git-clone). This often prevents
setuptools_scmfrom finding the most-recent tag from which to build the version number. This PR fixes that issue by "unshallowing" the clone back to at least the latest tag. It also prevents having a dirty git index (which can also alter the version) during the RTD build (https://docs.readthedocs.io/en/stable/build-customization.html#avoid-having-a-dirty-git-index).Fixes: #1588