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

Docs issue #545

Closed
zain-sohail opened this issue Jan 10, 2025 · 3 comments · Fixed by #548
Closed

Docs issue #545

zain-sohail opened this issue Jan 10, 2025 · 3 comments · Fixed by #548

Comments

@zain-sohail
Copy link
Member

zain-sohail commented Jan 10, 2025

Somehow the latest docs is 0.3.3 even though v0.4.0 is published to PyPi. Stable seems to be correct but on README, the latest is linked.

Second issue brought up by dima is non-working instructions for developers workflow. The current contributions page with uv needs to be updated as this can't work without sudo access.
I suggest similar to installing poetry with pipx, we do the same for uv (I tested and it works).

also trying

uv pip install -e .[dev,notebook]

leads to a

warning: The package `sed-processor @ <Path> does not have an extra named `dev`

if i try to install

@rettigl
Copy link
Member

rettigl commented Jan 11, 2025

Somehow the latest docs is 0.3.3 even though v0.4.0 is published to PyPi. Stable seems to be correct but on README, the latest is linked.

Yes indeed I also noticed that. A release creates the docs, but the latest does not get updated until you push something again to main. We should probably set the official docs link to the "stable" version, i.e. the latest release. This also removes the "unstable" header from the docs.

Second issue brought up by dima is non-working instructions for developers workflow. The current contributions page with uv needs to be updated as this can't work without sudo access.

What exactly does not work there? uv installs into the user space without sudo, I tested this on various machines.

I suggest similar to installing poetry with pipx, we do the same for uv (I tested and it works).

also trying

uv pip install -e .[dev,notebook]

leads to a

warning: The package `sed-processor @ <Path> does not have an extra named `dev`

if i try to install

Are you sure you have the updated config checked out? For me I am pretty sure this worked with the new pyproject...

@rettigl rettigl linked a pull request Jan 12, 2025 that will close this issue
@zain-sohail
Copy link
Member Author

Yes indeed I also noticed that. A release creates the docs, but the latest does not get updated until you push something again to main. We should probably set the official docs link to the "stable" version, i.e. the latest release. This also removes the "unstable" header from the docs.

But that is quite unexpected no? That the latest version lags behind main. I can think that we either update the workflow here or create one on docs repo to copy the

Are you sure you have the updated config checked out? For me I am pretty sure this worked with the new pyproject...
Trying again, it worked. Maybe it was a different branch.

I notice that you set dynamic versioning and there's no way to set 1.0? Because it's installing 0.4.1

@rettigl
Copy link
Member

rettigl commented Jan 12, 2025

But that is quite unexpected no? That the latest version lags behind main. I can think that we either update the workflow here or create one on docs repo to copy the

I can change the workflow accordingly. "current" only gets updated by push to main, and not releases, that is why.

I notice that you set dynamic versioning and there's no way to set 1.0? Because it's installing 0.4.1

With the dynamic versioning, this follows the lastest tag. It will automatically become v1.0.0 once we release. We can also probably create a rc tag to create such a version after we merge v1 branch.

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 a pull request may close this issue.

2 participants