Skip to content

docs: update theme 1.9 #736

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.

Sign up for GitHub

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

Open
dgarcia360 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: update theme 1.9 #736

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/dependabot.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
version: 2
updates:
- package-ecosystem: "pip"
- package-ecosystem: "uv"
directory: "/docs"
schedule:
interval: "daily"
Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/docs-pr.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ name: "Docs / Build PR"
# For more information,
# see https://sphinx-theme.scylladb.com/stable/deployment/production.html#available-workflows

permissions:
contents: read

Comment on lines +5 to +7
Copy link

@Lorak-mmk Lorak-mmk Mar 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting that here contents: write is not present. I'm even more curious now about why PRs in other repos have it.

Copy link

@annastuchlik annastuchlik Mar 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll defer to @dgarcia360

Copy link
Collaborator Author

@dgarcia360 dgarcia360 Mar 16, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docs-pr workflow doesn't need write permissions. It only builds the docs on new PRs for validation purposes.

The docs-pages workflow might need write permissions. Some repos (like this one) still use an older workflow that pushes to a github-pages branch, which requires contents: write. We propagated that permission from the theme repo, but it may not actually be necessary in repos using the newer GitHub Actions deploy workflow. I'll roll it back in those repos.

on:
push:
branches:
Expand Down
2 changes: 2 additions & 0 deletions docs/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Track uv.lock for reproducible docs builds
!uv.lock
2 changes: 1 addition & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
'sphinx_sitemap',
'sphinx_scylladb_theme',
'sphinx_multiversion', # optional
'recommonmark', # optional
'myst_parser', # optional
]

# Add any paths that contain templates here, relative to this directory.
Expand Down
8 changes: 4 additions & 4 deletions docs/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ dependencies = [
"gevent>=25.9.1,<26.0.0",
"gremlinpython==3.7.4",
"pygments>=2.19.2,<3.0.0",
"recommonmark==0.7.1",
"myst-parser>=5.0.0",
"redirects_cli~=0.1.3",
"sphinx-autobuild>=2025.0.0,<2026.0.0",
"sphinx-sitemap>=2.8.0,<3.0.0",
"sphinx-scylladb-theme>=1.8.2,<2.0.0",
"sphinx-scylladb-theme>=1.9.1",
"sphinx-multiversion-scylla>=0.3.2,<1.0.0",
"sphinx>=8.2.3,<9.0.0",
"sphinx>=9.0",
"six>=1.9",
"tornado>=6.5,<7.0",
]
Expand Down Expand Up @@ -57,4 +57,4 @@ exclude = [
"**/__pycache__/**",
"**/*.pyc",
".venv/**",
]
]
89 changes: 33 additions & 56 deletions docs/uv.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading