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
10 changes: 5 additions & 5 deletions .github/workflows/docs-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,19 @@ jobs:
fetch-depth: 0

- uses: actions/cache@v5
# actions/setup-python@v6 poetry cache feature requires poetry to be installed beforehand
# which makes use of it extremely awkward.
with:
path: |
/home/runner/.cache/pip
/home/runner/.cache/pypoetry
# python and poetry version are in docs/pyproject.toml
/home/runner/.cache/uv
key: docs-cache-${{ runner.os }}-${{ hashFiles('docs/pyproject.toml', 'docs/Makefile') }}

- name: Set up Python
uses: actions/setup-python@v6
with:
python-version-file: docs/pyproject.toml
python-version: '3.12'

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

- name: Set up env
run: make -C docs setupenv
Expand Down
12 changes: 6 additions & 6 deletions .github/workflows/docs-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,22 +28,22 @@ jobs:
fetch-depth: 0

- uses: actions/cache@v5
# actions/setup-python@v6 poetry cache feature requires poetry to be installed beforehand
# which makes use of it extremely awkward.
with:
path: |
/home/runner/.cache/pip
/home/runner/.cache/pypoetry
# python and poetry version are in docs/pyproject.toml
/home/runner/.cache/uv
key: docs-cache-${{ runner.os }}-${{ hashFiles('docs/pyproject.toml', 'docs/Makefile') }}

- name: Set up Python
uses: actions/setup-python@v6
with:
python-version-file: docs/pyproject.toml
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
run: make -C docs test
run: make -C docs test
18 changes: 9 additions & 9 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
SHELL=bash
# Global variables
# 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 @@ -30,18 +30,18 @@ setupenv:
for item in "$${items[@]}"; do\
item="$${item%\"}";\
item="$${item#\"}";\
pip install "$$item";\
pip install -q uv;\
done;\
fi;\
done < pyproject.toml

.PHONY: setup
setup:
$(POETRY) install
$(UV) sync

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

# Clean commands
.PHONY: pristine
Expand Down Expand Up @@ -79,24 +79,24 @@ epub3: setup

.PHONY: multiversion
multiversion: setup
$(POETRY) run sphinx-multiversion source $(BUILDDIR)/dirhtml
$(UV) run sphinx-multiversion source $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(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."

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

.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,313 changes: 0 additions & 1,313 deletions docs/poetry.lock

This file was deleted.

32 changes: 13 additions & 19 deletions docs/pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,21 +1,15 @@
[tool.poetry]
[project]
name = "sphinx-docs"
description = "ScyllaDB gocql driver documentation"
description = "ScyllaDB Documentation"
version = "0.1.0"
authors = ["ScyllaDB Documentation Contributors"]
package-mode = false

[tool.poetry.dependencies]
python = ">=3.11,<3.14"
pygments = "^2.19.2"
sphinx-scylladb-theme = "^1.8.2"
myst-parser = "^5.0.0"
sphinx-autobuild = "^2025.0.0"
Sphinx = "^8.0.0"
sphinx-multiversion-scylla = "^0.3.2"
sphinx-sitemap = "^2.8.0"
redirects_cli ="^0.1.3"

[build-system]
requires = ["poetry==2.3.4"]
build-backend = "poetry.masonry.api"
requires-python = ">=3.11"
dependencies = [
"pygments>=2.19.2",
"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",
]
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@

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

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "sphinx"
Expand Down
Loading
Loading