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

Update to use latest sphinx-scylladb-theme #1893

Closed
tnozicka opened this issue Apr 15, 2024 · 4 comments · Fixed by #1895
Closed

Update to use latest sphinx-scylladb-theme #1893

tnozicka opened this issue Apr 15, 2024 · 4 comments · Fixed by #1895
Assignees
Labels
kind/documentation Categorizes issue or PR as related to documentation. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.

Comments

@tnozicka
Copy link
Member

Latest sphinx-scylladb-theme contains several bug fixes we asked for so we should bump to >=1.7.1. This should make our docs look quite better.

@tnozicka tnozicka added priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. kind/documentation Categorizes issue or PR as related to documentation. labels Apr 15, 2024
@tnozicka
Copy link
Member Author

Although the releases are out, the stable docs are on 1.6.x.
The upgrade guide is available in master docs - https://sphinx-theme.scylladb.com/master/upgrade/1-6-to-1-7.html

@annastuchlik are the docs just stale or should we wait with v1.7.1 upgrade?

@tnozicka tnozicka changed the title Update to use latest sphinx-scylladb-theme theme Update to use latest sphinx-scylladb-theme Apr 15, 2024
@annastuchlik
Copy link

Please do wait a little. We need to do it according to the schedule in scylladb/sphinx-scylladb-theme#1035. We're hoping to be ready this week.

@tnozicka
Copy link
Member Author

@annastuchlik sure, but I am slightly confused which event makes the release? How do we watch for the new releases to be available, so we know when to pick them up? For most project this is done by watching the GitHub releases and it was released there https://github.com/scylladb/sphinx-scylladb-theme/releases/tag/1.7.1

@dgarcia360
Copy link
Contributor

dgarcia360 commented Apr 16, 2024

@tnozicka It's ok to update when a new tag is released. For the theme, updating the Python dependency directly is safe if only the patch version changes.

However, if the major or minor number are updated, it usually requires some additional changes, such editing other files than pyproject.toml. In these cases, we open issues for the affected teams or provide assistance to help them migrate to the latest versions during the following weeks after the release.

For updating to the latest version 1.7.1, please refer to this guide: https://sphinx-theme.scylladb.com/stable/upgrade/1-6-to-1-7.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants