Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
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
6 changes: 5 additions & 1 deletion .github/workflows/docs-pages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ on:
jobs:
release:
runs-on: ubuntu-latest
permissions:
contents: write
Comment on lines +18 to +19
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Any here we have it again :( why?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

We are now explicitly defining the minimum required permissions per workflow. The contents: write permission is needed here because deploy.sh pushes the built docs to the gh-pages branch.

steps:
- name: Checkout
uses: actions/checkout@v4
Expand All @@ -25,7 +27,9 @@ jobs:
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.10'
python-version: '3.12'
- name: Install uv
uses: astral-sh/setup-uv@v6
Comment on lines +30 to +32
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

There is v7 of that job already.

Copy link
Copy Markdown
Author

@dgarcia360 dgarcia360 Mar 16, 2026

Choose a reason for hiding this comment

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

Good catch! This PR was auto-propagated across +20 repos. We can bump to v7 in a follow-up after merging.

- name: Set up env
run: make -C docs setupenv
- name: Build docs
Expand Down
7 changes: 6 additions & 1 deletion .github/workflows/docs-pr.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ on:
- "docs/**"
- "topics/**"

permissions:
contents: read

jobs:
build:
runs-on: ubuntu-latest
Expand All @@ -22,7 +25,9 @@ jobs:
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.10'
python-version: '3.12'
- name: Install uv
uses: astral-sh/setup-uv@v6
- name: Set up env
run: make -C docs setupenv
- name: Build docs
Expand Down
18 changes: 9 additions & 9 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# You can set these variables from the command line.
POETRY = poetry
UV = uv
SPHINXOPTS = -j auto
SPHINXBUILD = $(POETRY) run sphinx-build
SPHINXBUILD = $(UV) run sphinx-build
PAPER =
BUILDDIR = _build
SOURCEDIR = _source
Expand All @@ -20,20 +20,20 @@ all: dirhtml
# Setup commands
.PHONY: setupenv
setupenv:
pip install -q poetry
pip install -q uv
sudo apt-get install doxygen

.PHONY: setup
setup:
$(POETRY) install
$(UV) sync
cd .. && doxygen Doxyfile.in
@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
$(UV) sync --upgrade

# Clean commands
.PHONY: pristine
Expand Down Expand Up @@ -61,7 +61,7 @@ singlehtml: setup

.PHONY: multiversion
multiversion: setup
$(POETRY) run ./_utils/multiversion.sh
$(UV) run ./_utils/multiversion.sh
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."

Expand All @@ -85,18 +85,18 @@ dummy: setup

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

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

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

# Test commands
.PHONY: test
Expand Down
1,641 changes: 0 additions & 1,641 deletions docs/poetry.lock

This file was deleted.

36 changes: 16 additions & 20 deletions docs/pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,24 +1,20 @@
[tool.poetry]
[project]
name = "cpp-driver"
description = "Scylla C/C++ Driver"
version = "0.1"
authors = ["ScyllaDB Documentation Contributors"]
package-mode = false
requires-python = ">=3.11"
dependencies = [
"breathe>=4.35.0",
"pygments>=2.18.0",
"sphinx-scylladb-theme>=1.9.1",
"myst-parser>=5.0.0",
"sphinx-autobuild>=2025.4.8",
"sphinx>=9.0",
"sphinx-multiversion-scylla>=0.3.7",
"sphinx-sitemap>=2.9.0",
"redirects_cli>=0.1.3",
"sphinx-scylladb-markdown>=0.1.2",
]

[tool.poetry.dependencies]
breathe="4.35.0"
python = "^3.10"
pygments = "^2.18.0"
redirects_cli ="^0.1.3"
sphinx-scylladb-theme = "^1.8.5"
sphinx-sitemap = "^2.6.0"
sphinx-autobuild = "^2024.4.19"
Sphinx = "^7.3.7"
sphinx-multiversion-scylla = "^0.3.1"
sphinx-scylladb-markdown = "^0.1.2"
[tool.poetry.dev-dependencies]
pytest = "5.2"

[build-system]
requires = ["poetry>=1.8.0"]
build-backend = "poetry.masonry.api"
[tool.uv]
package = false
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.venv']

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
Expand Down
1,092 changes: 1,092 additions & 0 deletions docs/uv.lock

Large diffs are not rendered by default.

Loading