docs: update theme 1.8 #20832
docs: update theme 1.8 #20832
Conversation
Docs Preview 📖Docs Preview for this pull request is available here Changed Files: Note: This preview will be available for 30 days and will be automatically deleted after that period. You can manually trigger a new build by committing changes. |
chore: update README
dgarcia360
force-pushed
the
docs-update-theme-1.8
branch
from
fc8b6c1 to
a6e9f67
Compare
annastuchlik
added
documentation
|
@denesb @kbr-scylla Please merge this PR. It updates the Sphinx theme, and we should make the update to all the projects at the same time. |
| description = "Scylla Documentation" | ||
| version = "4.3.0" | ||
| description = "ScyllaDB Documentation" | ||
| version = "0.1.0" |
There was a problem hiding this comment.
Why does version change from 4.3 to 0.1?
There was a problem hiding this comment.
When installing the docs locally, it shows "Installing the current project: ... (4.3.0)" because the ScyllaDB version was 4.3.0 when the toolchain was installed. We updated the version in pyproject.toml to avoid confusion, as we won't be releasing the docs as a Python package.
| @@ -0,0 +1,11 @@ | |||
| version: 2 | |||
There was a problem hiding this comment.
What does this do? Enable alerts?
There was a problem hiding this comment.
Dependabot will open automatic pull requests whenever the following packages receive updates:
- "sphinx-scylladb-theme"
- "sphinx-multiversion-scylla"
Previously, patch updates were automatically installed, but we’ve now changed the process so each project can control when to update. This automation simplifies that control.
There was a problem hiding this comment.
@kbr-scylla As a result, the maintainers of each project will have control over which version of the Sphinx theme is installed on the repo. I'll be reviewing the PRs opened by Dependabot, but it's up to the maintainers to merge them.
|
Unfortunately I'm currently unable to queue the PR due to #20855 |
|
Well, I'll just workaround this my own way |
Related issue scylladb/sphinx-scylladb-theme#1229
ScyllaDB Sphinx Theme 1.8 is out 🥳!
Here's a summary of changes:
poetry.lockfile to ensure consistent dependencies in your CI/CD pipeline.You can read more about all the notable changes here.
How to test this PR
Clone this PR.
Enter the docs folder, and run:
Open http://localhost:5500 in your browser. The doc should render without errors, and the version should be Sphinx Theme version (see the footer) must be
1.8.x: