Skip to content

Commit b625d14

Browse files
committed
Switch docs to uv
1 parent 5b0b725 commit b625d14

9 files changed

Lines changed: 439 additions & 11 deletions

File tree

.github/dependabot.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ updates:
88
schedule:
99
interval: "daily"
1010

11-
- package-ecosystem: "pip"
11+
- package-ecosystem: "uv"
1212
directory: "/docs"
1313
schedule:
1414
interval: "daily"

.readthedocs.yaml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ version: 2
77

88
# Set the version of Python and other tools you might need
99
build:
10-
os: ubuntu-22.04
10+
os: ubuntu-24.04
1111
tools:
1212
python: "3"
1313
# You can also specify other tool versions:
@@ -27,4 +27,6 @@ formats: all
2727
# Optionally declare the Python requirements required to build your docs
2828
python:
2929
install:
30-
- requirements: docs/requirements.txt
30+
- method: uv
31+
command: sync
32+
path: docs

docs/.python-version

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
3.14

docs/build.ps1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
pip install --user -r requirements.txt --upgrade --upgrade-strategy eager
2-
python -m sphinx . _build -E -a
1+
uv lock --upgrade
2+
uv run python -m sphinx . _build -E -a

docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545

4646
# General information about the project.
4747
project = u'Behat Code Coverage'
48-
copyright = u'2019-2024, Doug Wright'
48+
copyright = u'2019-2026, Doug Wright'
4949
author = u'Doug Wright'
5050

5151
# The version info for the project you're documenting, acts as replacement for
@@ -67,7 +67,7 @@
6767
# List of patterns, relative to source directory, that match files and
6868
# directories to ignore when looking for source files.
6969
# This patterns also effect to html_static_path and html_extra_path
70-
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
70+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.venv']
7171

7272
# The name of the Pygments (syntax highlighting) style to use.
7373
pygments_style = 'friendly'

docs/configuration.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ basis. It is configured by setting the ``html`` key. The default values are outl
293293
The ``colors`` and ``customCSSFile`` settings are only available from php-code-coverage v10
294294

295295
(Open)Clover
296-
^^^^^^^^^
296+
^^^^^^^^^^^^
297297
Originating from the Java world, Clover-format reports are a standard way of exchanging coverage data
298298
between tools. It is configured by setting the ``openclover`` or ``clover`` key. The default values are outlined below:
299299

docs/pyproject.toml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
[project]
2+
name = "docs"
3+
version = "1.0.0"
4+
requires-python = ">=3.14"
5+
dependencies = [
6+
"myst-parser~=4.0",
7+
"sphinx-rtd-theme~=3.0",
8+
]

docs/requirements.txt

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

docs/uv.lock

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