Skip to content

install the project on RTD #4350

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

Merged
merged 2 commits into from
Aug 18, 2020
Merged

install the project on RTD #4350

merged 2 commits into from
Aug 18, 2020

Conversation

keewis
Copy link
Collaborator

@keewis keewis commented Aug 18, 2020

The versions were broken because instead of installing we simply extended sys.path. That way, sphinx is able to find the correct version, but setuptools_scm can't put the version in the METADATA file in the installed egg. Instead, pkg_resources.get_distribution("xarray").version gets its version from a released version of xarray that was pulled in by a dependency (hence the old version in the title bar). To fix that, we need to install before building the documentation.

However, since RTD installs with --upgrade --upgrade-strategy=eager (which upgrades all packages to the most recent version), we can't install using their pip method. The setuptools method doesn't work either because cfgrib pulls in the most recent released version of xarray, and setuptools can't seem to overwrite / uninstall previously installed versions. To work around that, this installs using the pip section in the environment file.

@keewis keewis changed the title install the project on RTD using pip when creating the environment install the project on RTD Aug 18, 2020
@keewis
Copy link
Collaborator Author

keewis commented Aug 18, 2020

that seems to have fixed the version in the title bar, so this should be ready for review and merge

Copy link
Collaborator

@max-sixty max-sixty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, thanks @keewis , I know the digging was a lot of work. Great to have this fixed.

@keewis keewis merged commit 11d72d0 into pydata:master Aug 18, 2020
@keewis keewis deleted the fix-version-on-rtd branch August 18, 2020 22:32
@keewis
Copy link
Collaborator Author

keewis commented Aug 18, 2020

thanks for the reviews, @max-sixty and @dcherian

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.

title bar of docs displays incorrect version
3 participants