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

Fix RTD versioning with a deep git clone #2913

Merged
merged 1 commit into from
Sep 26, 2024

Conversation

mquinnfd
Copy link
Contributor

@mquinnfd mquinnfd commented Sep 26, 2024

Fixing published Locust version in RTD Docs

Currently the published docs using RTD have the wrong version of Locust during the docs build, because the full Git history isn't there. The tox tests previously had this issue when the base checkout didn't pull the whole git history. This results in something like the below:

locust -V
locust 0.0.1.dev286 from /usr/local/lib/python3.12/site-packages/locust (Python 3.12.5)

This PR updates this based on guidance from RTD's own docs, though it's difficult to actually test that this works without overwriting the current docs 🤔

RTD docs on this here:
https://docs.readthedocs.io/en/stable/build-customization.html#unshallow-git-clone

@cyberw cyberw merged commit 3313016 into locustio:master Sep 26, 2024
16 checks passed
@cyberw
Copy link
Collaborator

cyberw commented Sep 26, 2024

Seemed to work fantastically, at least in the prerelease build. Thanks!

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