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

title bar of docs displays incorrect version #4289

Closed
johnomotani opened this issue Jul 30, 2020 · 5 comments · Fixed by #4350
Closed

title bar of docs displays incorrect version #4289

johnomotani opened this issue Jul 30, 2020 · 5 comments · Fixed by #4350

Comments

@johnomotani
Copy link
Contributor

What happened:
The browser title bar displays an incorrect version when viewing the docs online. See below - title bar says 0.15.1 but actual version in URL is 0.16.0.
docs-snapshot

http://xarray.pydata.org/en/stable/ also displays 0.15.1 in the title bar, but I guess is actually showing 0.16.0 docs (?), which is confusing!

@keewis
Copy link
Collaborator

keewis commented Jul 30, 2020

thanks. Yes, there either seems to be something wrong with setuptool_scm, or we indeed didn't import the correct version of xarray (the build logs report that 0.15.1 was imported). This also doesn't work for the current latest: it says 0.16.0 instead of 0.16.1.devXY+gaabbccdd.

@keewis
Copy link
Collaborator

keewis commented Jul 30, 2020

actually, it seems the reason for this is #3567: by not installing, we never call setuptools_scm to set the version (it doesn't use the 999 version we use as a fallback either, though, it uses the other version installed: right now 0.16.0)

@keewis
Copy link
Collaborator

keewis commented Jul 30, 2020

to fix that, we'd need to install the project using pip, but RTD uses --upgrade --upgrade-strategy eager without --no-deps which means we wouldn't be able to use version pinning. So I guess we have to wait on RTD?

@dcherian
Copy link
Contributor

Thanks for tracking this down @keewis

@keewis
Copy link
Collaborator

keewis commented Aug 18, 2020

they don't want to add --no-deps to the install command (see readthedocs/readthedocs.org#7345 (comment)), but we can work around that by appending

  - pip
  - pip:
    # path to the folder containing setup.py relative to the environment file
    # if I understand it correctly, this feature is only available when using editable installs
    - -e ../..

to our environment file (not sure if there's documentation about this, but there's an example file). Something similar should also work with requirements files.

I'll send in a PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants