furo icon indicating copy to clipboard operation
furo copied to clipboard

Pin sphinx-basic-ng to a real version

Open Blendify opened this issue 1 year ago • 4 comments

The version number here does not correspond to a proper release on pypi and can cause some problems for some installations.

This was mistakenly changed in https://github.com/pradyunsg/furo/commit/2ce7e89cb799bcb1312b711b17fca90d2979fa21

Blendify avatar Nov 28 '24 17:11 Blendify

Thanks for filing this PR!

This difference should not matter for Python packages, since both of these forms normalize to the same value under the hood:

>>> from packaging.version import Version as V
>>> V("1.0.0b2")
<Version('1.0.0b2')>
>>> V("1.0.0.beta2")
<Version('1.0.0b2')>

pradyunsg avatar Jan 01 '25 20:01 pradyunsg

This difference should not matter for Python packages, since both of these forms normalize to the same value under the hood

And just to reinforce that a bit more, even a pip install will normalize the version and do the right thing:

$ pip --no-cache install sphinx-basic-ng==1.0.0.beta2
Collecting sphinx-basic-ng==1.0.0.beta2
  Downloading sphinx_basic_ng-1.0.0b2-py3-none-any.whl.metadata (1.5 kB)
[...]
Downloading sphinx_basic_ng-1.0.0b2-py3-none-any.whl (22 kB)
[...installs...]

So if an installation is having problems locating a package, they should normalize their versions first.

ferdnyc avatar Jan 01 '25 21:01 ferdnyc

Interesting, we had issues with Pipenv and https://github.com/pradyunsg/furo/commit/2ce7e89cb799bcb1312b711b17fca90d2979fa21

Prior to that release we didnt have to use --pre to install furo. Ideally it would be nice if we can get a real version of that dependency released.

Blendify avatar Jan 03 '25 01:01 Blendify

That sounds like a pipenv bug rather than a metadata issue in this package.

Prior to that release we didnt have to use --pre to install furo

That should also not be necessary. Pre-releases are supposed to be opted-in for that package, via the fact that the constraint allows for a pre-release.

None the less, I do plan to cut a non-pre-release version for that eventually -- there's a bunch of work on that end that I need to do.

https://github.com/pradyunsg/sphinx-theme-builder/issues/11

pradyunsg avatar Jan 03 '25 08:01 pradyunsg

Closing this out, since the dependency specified in this project is accurate.

pradyunsg avatar Jul 19 '25 10:07 pradyunsg