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.yaml
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
3 changes: 3 additions & 0 deletions .github/workflows/docs-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ jobs:
java-version: '8'
distribution: 'temurin'

- name: Install uv
uses: astral-sh/setup-uv@v6

- name: Set up env
Comment on lines +45 to 48
Copy link
Copy Markdown

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

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.

run: make -C docs setupenv

Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/docs-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ jobs:
java-version: '8'
distribution: 'temurin'

- name: Install uv
uses: astral-sh/setup-uv@v6

- name: Set up env
Comment on lines +40 to 43
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

ditto

run: make -C docs setupenv

Expand Down
20 changes: 10 additions & 10 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 @@ -19,19 +19,19 @@ all: dirhtml
# Setup commands
.PHONY: setupenv
setupenv:
pip install -q poetry
pip install -q uv

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

.PHONY: update
update:
$(POETRY) update
$(UV) sync --upgrade

# Clean commands
.PHONY: pristine
Expand All @@ -42,7 +42,7 @@ pristine: clean
clean:
rm -rf $(BUILDDIR)/*
rm -rf $(SOURCEDIR)/*
rm -f poetry.lock
rm -f uv.lock

# Generate output commands
.PHONY: dirhtml
Expand All @@ -60,7 +60,7 @@ javadoc: 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,15 +85,15 @@ dummy: setup
# 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

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

Expand Down
1,394 changes: 0 additions & 1,394 deletions docs/poetry.lock

This file was deleted.

40 changes: 19 additions & 21 deletions docs/pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,22 +1,20 @@
[tool.poetry]
name = "scylladb-java-driver-docs"
version = "3.7.1"
description = "ScyllaDB Java Driver"
authors = ["Java Driver Contributors"]
package-mode = false
[project]
name = "java-driver"
description = "ScyllaDB Java Driver Documentation"
version = "0.1.0"
requires-python = ">=3.11"
dependencies = [
"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",
"wheel>=0.45.0",
"sphinx-scylladb-markdown>=0.1.2",
]

[tool.poetry.dependencies]
python = "^3.13"
pygments = "^2.19.2"
redirects_cli = "^0.1.3"
sphinx-scylladb-theme = "^1.9.1"
sphinx-sitemap = "^2.8.0"
sphinx-autobuild = "^2025.0.0"
Sphinx = "^8.0.0"
sphinx-multiversion-scylla = "^0.3.7"
wheel = "^0.46.0"
sphinx-scylladb-markdown = "^0.1.2"

[build-system]
requires = ["poetry>=1.8"]
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 @@ -71,7 +71,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', '_utils']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '_utils', '.venv']

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

Large diffs are not rendered by default.

Loading