docs: update to theme 1.8.3 and bring improvements from 3.x to set 4.x as default branch

.github/dependabot.yaml

@@ -0,0 +1,9 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/docs"
+    schedule:
+      interval: "daily"
+    allow:
+      - dependency-name: "sphinx-scylladb-theme"
+      - dependency-name: "sphinx-multiversion-scylla"

.github/workflows/docs-pages.yaml

@@ -6,7 +6,7 @@ on:
   push:
     branches:
     - scylla-3.x
-    - 'branch-**'
+    - 'scylla-**'
     paths:
     - 'docs/**'
     - 'faq/**'
@@ -30,9 +30,10 @@ jobs:
         with:
           python-version: '3.10'
       - name: Set up JDK 1.8
-        uses: actions/setup-java@v1
+        uses: actions/setup-java@v4
         with:
-          java-version: 1.8
+          java-version: '8'
+          distribution: 'adopt'
       - name: Set up env
         run: make -C docs setupenv
       - name: Build redirects

.github/workflows/docs-pr.yaml

@@ -15,22 +15,27 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
       - name: Checkout
         uses: actions/checkout@v4
         with:
           persist-credentials: false
           fetch-depth: 0
+
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
           python-version: '3.10'
+
       - name: Set up JDK 1.8
-        uses: actions/setup-java@v1
+        uses: actions/setup-java@v4
         with:
-          java-version: 1.8
+          java-version: '8'
+          distribution: 'adopt'
+
       - name: Set up env
         run: make -C docs setupenv
+
       - name: Build docs
-        run: make -C docs test
+        run: make -C docs test

.gitignore

@@ -17,6 +17,5 @@ latex
 .documenter_local_last_run
 docs/_build
 docs/_source
-docs/poetry.lock
 target/
 dependency-reduced-pom.xml

docs/Makefile

@@ -24,11 +24,14 @@ setupenv:
 .PHONY: setup
 setup:
 	$(POETRY) install
-	$(POETRY) update
 	@if [ ! -d "$(SOURCEDIR)" ]; then mkdir -p "$(SOURCEDIR)"; fi
 	cp -RL source/* $(SOURCEDIR)
 	cd $(SOURCEDIR) && find . -name README.md -execdir mv '{}' index.md ';'
 
+.PHONY: update
+update:
+	$(POETRY) update
+
 # Clean commands
 .PHONY: pristine
 pristine: clean

docs/pyproject.toml

@@ -3,20 +3,20 @@ name = "java-driver"
 version = "3.7.1"
 description = "ScyllaDB Java Driver"
 authors = ["Java Driver Contributors"]
+package-mode = false
 
 [tool.poetry.dependencies]
-python = "^3.9"
-pyyaml = "6.0.1"
-pygments = "2.15.1"
-redirects_cli ="~0.1.3"
-sphinx-scylladb-theme = "~1.7.2"
-sphinx-sitemap = "2.5.1"
-sphinx-autobuild = "2021.3.14"
-Sphinx = "7.2.6"
-sphinx-multiversion-scylla = "~0.3.1"
+python = "^3.10"
+pygments = "^2.18.0"
+redirects_cli ="^0.1.3"
+sphinx-scylladb-theme = "^1.8.1"
+sphinx-sitemap = "^2.6.0"
+sphinx-autobuild = "^2024.4.19"
+Sphinx = "^7.3.7"
+sphinx-multiversion-scylla = "^0.3.1"
 wheel = "^0.38.4"
 sphinx-scylladb-markdown = "^0.1.2"
 
 [build-system]
-requires = ["poetry>=0.12"]
-build-backend = "poetry.masonry.api" 
+requires = ["poetry>=1.8"]
+build-backend = "poetry.masonry.api"

docs/source/conf.py

@@ -138,6 +138,7 @@
     'conf_py_path': 'docs/source/',
     'branch_substring_removed': 'scylla-',
     'github_repository': 'scylladb/java-driver',
+    'default_branch': 'scylla-4.x',
     'github_issues_repository': 'scylladb/java-driver',
     'hide_edit_this_page_button': 'false',
     'hide_feedback_buttons': 'false',