Skip to content

Commit 623e210

Browse files
authored
Merge pull request #121 from dgarcia360/docs-update-1.9
docs: update theme 1.9
2 parents bbe65bc + 246226e commit 623e210

8 files changed

Lines changed: 1130 additions & 1674 deletions

File tree

.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.yaml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ on:
1515
jobs:
1616
release:
1717
runs-on: ubuntu-latest
18+
permissions:
19+
contents: write
1820
steps:
1921
- name: Checkout
2022
uses: actions/checkout@v4
@@ -25,7 +27,9 @@ jobs:
2527
- name: Set up Python
2628
uses: actions/setup-python@v5
2729
with:
28-
python-version: '3.10'
30+
python-version: '3.12'
31+
- name: Install uv
32+
uses: astral-sh/setup-uv@v6
2933
- name: Set up env
3034
run: make -C docs setupenv
3135
- name: Build docs

.github/workflows/docs-pr.yaml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ on:
1010
- "docs/**"
1111
- "topics/**"
1212

13+
permissions:
14+
contents: read
15+
1316
jobs:
1417
build:
1518
runs-on: ubuntu-latest
@@ -22,7 +25,9 @@ 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+
- name: Install uv
30+
uses: astral-sh/setup-uv@v6
2631
- name: Set up env
2732
run: make -C docs setupenv
2833
- name: Build docs

docs/Makefile

Lines changed: 9 additions & 9 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
@@ -20,20 +20,20 @@ all: dirhtml
2020
# Setup commands
2121
.PHONY: setupenv
2222
setupenv:
23-
pip install -q poetry
23+
pip install -q uv
2424
sudo apt-get install doxygen
2525

2626
.PHONY: setup
2727
setup:
28-
$(POETRY) install
28+
$(UV) sync
2929
cd .. && doxygen Doxyfile.in
3030
@if [ ! -d "$(SOURCEDIR)" ]; then mkdir -p "$(SOURCEDIR)"; fi
3131
cp -RL source/* $(SOURCEDIR)
3232
cd $(SOURCEDIR) && find . -name README.md -execdir mv '{}' index.md ';'
3333

3434
.PHONY: update
3535
update:
36-
$(POETRY) update
36+
$(UV) sync --upgrade
3737

3838
# Clean commands
3939
.PHONY: pristine
@@ -61,7 +61,7 @@ singlehtml: setup
6161

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

@@ -85,18 +85,18 @@ dummy: setup
8585

8686
.PHONY: redirects
8787
redirects: setup
88-
$(POETRY) run redirects-cli fromfile --yaml-file _utils/redirects.yaml --output-dir $(BUILDDIR)/dirhtml
88+
$(UV) run redirects-cli fromfile --yaml-file _utils/redirects.yaml --output-dir $(BUILDDIR)/dirhtml
8989
@echo
9090
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
9191

9292
# Preview commands
9393
.PHONY: preview
9494
preview: setup
95-
$(POETRY) run sphinx-autobuild -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml --port 5500 --re-ignore 'api/*'
95+
$(UV) run sphinx-autobuild -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml --port 5500 --re-ignore 'api/*'
9696

9797
.PHONY: multiversionpreview
9898
multiversionpreview: multiversion
99-
$(POETRY) run python -m http.server 5500 --directory $(BUILDDIR)/dirhtml
99+
$(UV) run python -m http.server 5500 --directory $(BUILDDIR)/dirhtml
100100

101101
# Test commands
102102
.PHONY: test

docs/poetry.lock

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

docs/pyproject.toml

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,20 @@
1-
[tool.poetry]
1+
[project]
22
name = "cpp-driver"
33
description = "Scylla C/C++ Driver"
44
version = "0.1"
5-
authors = ["ScyllaDB Documentation Contributors"]
6-
package-mode = false
5+
requires-python = ">=3.11"
6+
dependencies = [
7+
"breathe>=4.35.0",
8+
"pygments>=2.18.0",
9+
"sphinx-scylladb-theme>=1.9.1",
10+
"myst-parser>=5.0.0",
11+
"sphinx-autobuild>=2025.4.8",
12+
"sphinx>=9.0",
13+
"sphinx-multiversion-scylla>=0.3.7",
14+
"sphinx-sitemap>=2.9.0",
15+
"redirects_cli>=0.1.3",
16+
"sphinx-scylladb-markdown>=0.1.2",
17+
]
718

8-
[tool.poetry.dependencies]
9-
breathe="4.35.0"
10-
python = "^3.10"
11-
pygments = "^2.18.0"
12-
redirects_cli ="^0.1.3"
13-
sphinx-scylladb-theme = "^1.8.5"
14-
sphinx-sitemap = "^2.6.0"
15-
sphinx-autobuild = "^2024.4.19"
16-
Sphinx = "^7.3.7"
17-
sphinx-multiversion-scylla = "^0.3.1"
18-
sphinx-scylladb-markdown = "^0.1.2"
19-
[tool.poetry.dev-dependencies]
20-
pytest = "5.2"
21-
22-
[build-system]
23-
requires = ["poetry>=1.8.0"]
24-
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
@@ -59,7 +59,7 @@
5959
# List of patterns, relative to source directory, that match files and
6060
# directories to ignore when looking for source files.
6161
# This patterns also effect to html_static_path and html_extra_path
62-
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
62+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.venv']
6363

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

docs/uv.lock

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