Skip to content

Commit 39e9715

Browse files
committed
docs: update theme 1.9
1 parent fc871b7 commit 39e9715

8 files changed

Lines changed: 1014 additions & 1423 deletions

File tree

.github/dependabot.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
version: 2
22
updates:
3-
- package-ecosystem: "pip"
3+
- package-ecosystem: "uv"
44
directory: "/docs"
55
schedule:
66
interval: "daily"

.github/workflows/docs-pages.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ on:
1818
jobs:
1919
release:
2020
runs-on: ubuntu-latest
21+
permissions:
22+
contents: write
2123
concurrency:
2224
group: single
2325
cancel-in-progress: true
@@ -40,6 +42,9 @@ jobs:
4042
java-version: '8'
4143
distribution: 'temurin'
4244

45+
- name: Install uv
46+
uses: astral-sh/setup-uv@v6
47+
4348
- name: Set up env
4449
run: make -C docs setupenv
4550

.github/workflows/docs-pr.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@ name: "Docs / Build PR"
22
# For more information,
33
# see https://sphinx-theme.scylladb.com/stable/deployment/production.html#available-workflows
44

5+
permissions:
6+
contents: read
7+
58
on:
69
pull_request:
710
branches:
@@ -34,6 +37,9 @@ jobs:
3437
java-version: '8'
3538
distribution: 'temurin'
3639

40+
- name: Install uv
41+
uses: astral-sh/setup-uv@v6
42+
3743
- name: Set up env
3844
run: make -C docs setupenv
3945

docs/Makefile

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# You can set these variables from the command line.
2-
POETRY = poetry
2+
UV = uv
33
SPHINXOPTS = -j auto
4-
SPHINXBUILD = $(POETRY) run sphinx-build
4+
SPHINXBUILD = $(UV) run sphinx-build
55
PAPER =
66
BUILDDIR = _build
77
SOURCEDIR = _source
@@ -19,19 +19,19 @@ all: dirhtml
1919
# Setup commands
2020
.PHONY: setupenv
2121
setupenv:
22-
pip install -q poetry
22+
pip install -q uv
2323

2424
.PHONY: setup
2525
setup:
26-
$(POETRY) install
26+
$(UV) sync
2727
@if [ ! -d "$(SOURCEDIR)" ]; then mkdir -p "$(SOURCEDIR)"; fi
2828
cp -RL source/* $(SOURCEDIR)
2929
cd $(SOURCEDIR) && find . -name README.md -execdir mv '{}' index.md ';'
3030
cd $(SOURCEDIR) && find . -name README.rst -execdir mv '{}' index.rst ';'
3131

3232
.PHONY: update
3333
update:
34-
$(POETRY) update
34+
$(UV) sync --upgrade
3535

3636
# Clean commands
3737
.PHONY: pristine
@@ -42,7 +42,7 @@ pristine: clean
4242
clean:
4343
rm -rf $(BUILDDIR)/*
4444
rm -rf $(SOURCEDIR)/*
45-
rm -f poetry.lock
45+
rm -f uv.lock
4646

4747
# Generate output commands
4848
.PHONY: dirhtml
@@ -60,7 +60,7 @@ javadoc: setup
6060

6161
.PHONY: multiversion
6262
multiversion: setup
63-
$(POETRY) run ./_utils/multiversion.sh
63+
$(UV) run ./_utils/multiversion.sh
6464
@echo
6565
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
6666

@@ -85,15 +85,15 @@ dummy: setup
8585
# Preview commands
8686
.PHONY: preview
8787
preview: setup
88-
$(POETRY) run sphinx-autobuild -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml --port 5500 --re-ignore 'api/*'
88+
$(UV) run sphinx-autobuild -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml --port 5500 --re-ignore 'api/*'
8989

9090
.PHONY: multiversionpreview
9191
multiversionpreview: multiversion
92-
$(POETRY) run python -m http.server 5500 --directory $(BUILDDIR)/dirhtml
92+
$(UV) run python -m http.server 5500 --directory $(BUILDDIR)/dirhtml
9393

9494
.PHONY: redirects
9595
redirects: setup
96-
$(POETRY) run redirects-cli fromfile --yaml-file _utils/redirects.yaml --output-dir $(BUILDDIR)/dirhtml
96+
$(UV) run redirects-cli fromfile --yaml-file _utils/redirects.yaml --output-dir $(BUILDDIR)/dirhtml
9797
@echo
9898
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
9999

docs/poetry.lock

Lines changed: 0 additions & 1391 deletions
This file was deleted.

docs/pyproject.toml

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,20 @@
1-
[tool.poetry]
1+
[project]
22
name = "java-driver"
3-
version = "3.7.1"
4-
description = "ScyllaDB Java Driver"
5-
authors = ["Java Driver Contributors"]
6-
package-mode = false
3+
description = "ScyllaDB Java Driver Documentation"
4+
version = "0.1.0"
5+
requires-python = ">=3.12"
6+
dependencies = [
7+
"pygments>=2.18.0",
8+
"sphinx-scylladb-theme>=1.9.1",
9+
"myst-parser>=5.0.0",
10+
"sphinx-autobuild>=2025.4.8",
11+
"sphinx>=9.0",
12+
"sphinx-multiversion-scylla>=0.3.7",
13+
"sphinx-sitemap>=2.9.0",
14+
"redirects_cli>=0.1.3",
15+
"wheel>=0.45.0",
16+
"sphinx-scylladb-markdown>=0.1.2",
17+
]
718

8-
[tool.poetry.dependencies]
9-
python = "^3.13"
10-
pygments = "^2.19.2"
11-
redirects_cli ="^0.1.3"
12-
sphinx-scylladb-theme = "^1.8.10"
13-
sphinx-sitemap = "^2.8.0"
14-
sphinx-autobuild = "^2025.0.0"
15-
Sphinx = "^8.0.0"
16-
sphinx-multiversion-scylla = "^0.3.4"
17-
wheel = "^0.45.0"
18-
sphinx-scylladb-markdown = "^0.1.2"
19-
20-
[build-system]
21-
requires = ["poetry>=1.8"]
22-
build-backend = "poetry.masonry.api"
19+
[tool.uv]
20+
package = false

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@
7171
# List of patterns, relative to source directory, that match files and
7272
# directories to ignore when looking for source files.
7373
# This patterns also effect to html_static_path and html_extra_path
74-
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '_utils']
74+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '_utils', '.venv']
7575

7676
# The name of the Pygments (syntax highlighting) style to use.
7777
pygments_style = 'sphinx'

docs/uv.lock

Lines changed: 973 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)