Skip to content

Commit 220b7f7

Browse files
committed
docs: update theme 1.9
1 parent 38763b1 commit 220b7f7

File tree

8 files changed

+938
-1411
lines changed

8 files changed

+938
-1411
lines changed

.github/dependabot.yml

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: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,10 @@ jobs:
2424
- name: Set up Python
2525
uses: actions/setup-python@v5
2626
with:
27-
python-version: '3.10'
27+
python-version: '3.12'
28+
29+
- name: Install uv
30+
uses: astral-sh/setup-uv@v6
2831

2932
- name: Set up env
3033
run: make -C docs setupenv
@@ -58,7 +61,7 @@ jobs:
5861
permissions:
5962
pages: write # to deploy to Pages
6063
id-token: write # to verify the deployment originates from an appropriate source
61-
contents: read # to read private repo
64+
contents: write # to read private repo
6265

6366
# Deploy to the github-pages environment
6467
environment:
@@ -70,4 +73,4 @@ jobs:
7073
steps:
7174
- name: Deploy to GitHub Pages
7275
id: deployment
73-
uses: actions/deploy-pages@v4
76+
uses: actions/deploy-pages@v4

.github/workflows/docs-pr.yml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ on:
99
paths:
1010
- "docs/**"
1111

12+
permissions:
13+
contents: read
14+
1215
jobs:
1316
build:
1417
runs-on: ubuntu-latest
@@ -22,10 +25,13 @@ jobs:
2225
- name: Set up Python
2326
uses: actions/setup-python@v5
2427
with:
25-
python-version: '3.10'
28+
python-version: '3.12'
29+
30+
- name: Install uv
31+
uses: astral-sh/setup-uv@v6
2632

2733
- name: Set up env
2834
run: make -C docs setupenv
2935

3036
- name: Build docs
31-
run: make -C docs test
37+
run: make -C docs test

docs/Makefile

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Global variables
22
# You can set these variables from the command line.
3-
POETRY = poetry
3+
UV = uv
44
SPHINXOPTS = -j auto
5-
SPHINXBUILD = $(POETRY) run sphinx-build
5+
SPHINXBUILD = $(UV) run sphinx-build
66
PAPER =
77
BUILDDIR = _build
88
SOURCEDIR = source
@@ -19,15 +19,15 @@ 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

2828
.PHONY: update
2929
update:
30-
$(POETRY) update
30+
$(UV) sync --upgrade
3131

3232
# Clean commands
3333
.PHONY: pristine
@@ -65,24 +65,24 @@ epub3: setup
6565

6666
.PHONY: multiversion
6767
multiversion: setup
68-
$(POETRY) run sphinx-multiversion source $(BUILDDIR)/dirhtml
68+
$(UV) run sphinx-multiversion source $(BUILDDIR)/dirhtml
6969
@echo
7070
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
7171

7272
.PHONY: redirects
7373
redirects: setup
74-
$(POETRY) run redirects-cli fromfile --yaml-file _utils/redirects.yaml --output-dir $(BUILDDIR)/dirhtml
74+
$(UV) run redirects-cli fromfile --yaml-file _utils/redirects.yaml --output-dir $(BUILDDIR)/dirhtml
7575
@echo
7676
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
7777

7878
# Preview commands
7979
.PHONY: preview
8080
preview: setup
81-
$(POETRY) run sphinx-autobuild -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml --port 5500
81+
$(UV) run sphinx-autobuild -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml --port 5500
8282

8383
.PHONY: multiversionpreview
8484
multiversionpreview: multiversion
85-
$(POETRY) run python -m http.server 5500 --directory $(BUILDDIR)/dirhtml
85+
$(UV) run python -m http.server 5500 --directory $(BUILDDIR)/dirhtml
8686

8787
# Test commands
8888
.PHONY: test

docs/poetry.lock

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

docs/pyproject.toml

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,18 @@
1-
[tool.poetry]
1+
[project]
22
name = "sphinx-docs"
3-
description = "ScyllaDB gocql driver documentation"
3+
description = "ScyllaDB Documentation"
44
version = "0.1.0"
5-
authors = ["ScyllaDB Documentation Contributors"]
6-
package-mode = false
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+
]
716

8-
[tool.poetry.dependencies]
9-
python = "^3.10"
10-
pygments = "^2.18.0"
11-
sphinx-scylladb-theme = "^1.8.1"
12-
myst-parser = "^3.0.1"
13-
sphinx-autobuild = "^2024.4.19"
14-
Sphinx = "^7.3.7"
15-
sphinx-multiversion-scylla = "^0.3.1"
16-
sphinx-sitemap = "^2.6.0"
17-
redirects_cli ="^0.1.3"
18-
19-
[build-system]
20-
requires = ["poetry>=1.8.0"]
21-
build-backend = "poetry.masonry.api"
17+
[tool.uv]
18+
package = false

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050

5151
# List of patterns, relative to source directory, that match files and
5252
# directories to ignore when looking for source files.
53-
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "**/_partials"]
53+
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "**/_partials", ".venv"]
5454

5555
# The name of the Pygments (syntax highlighting) style to use.
5656
pygments_style = "sphinx"

docs/uv.lock

Lines changed: 898 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)