Skip to content
Merged
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/workflows/build-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ jobs:
- name: Install dependencies
run: |
pip install --upgrade pip
pip install -r docs/requirements.txt
pip install --group docs
- name: Build the documentation
run: make -C docs html
8 changes: 3 additions & 5 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,15 @@ jobs:

steps:
- uses: actions/checkout@v6
- name: Set up Python 3
uses: actions/setup-python@v6
- uses: actions/setup-python@v6
with:
python-version: 3
python-version: "3.14"
cache: "pip"
cache-dependency-path: "test-requirements.txt"

- name: Install dependencies
run: |
pip install --upgrade pip
pip install -r test-requirements.txt
pip install --group test

- name: Lint implementation
run: flake8
8 changes: 6 additions & 2 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,17 @@
version: 2

build:
os: ubuntu-22.04
os: ubuntu-26.04
tools:
python: "3"
jobs:
install:
- uv sync --group docs

sphinx:
configuration: docs/conf.py

python:
install:
- requirements: docs/requirements.txt
- method: uv
command: sync
5 changes: 3 additions & 2 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
# from the environment for the first two.
SOURCEDIR = .
SOURCES =
ROOTDIR = ..
BUILDDIR = _build
PYTHON = python3
VENVDIR = ./venv
Expand Down Expand Up @@ -38,8 +39,8 @@ text: build

venv:
$(PYTHON) -m venv $(VENVDIR)
$(VENVDIR)/bin/python3 -m pip install -U pip setuptools
$(VENVDIR)/bin/python3 -m pip install -r requirements.txt
$(VENVDIR)/bin/python3 -m pip install -U pip
$(VENVDIR)/bin/python3 -m pip install --group $(ROOTDIR)/pyproject.toml:docs
@echo "The venv has been created in the $(VENVDIR) directory"

# Catch-all target: route all unknown targets to Sphinx using the new
Expand Down
10 changes: 0 additions & 10 deletions docs/requirements.txt

This file was deleted.

21 changes: 21 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
[project]
name = "typing"
version = "1" # dummy
requires-python = ">= 3.12" # for building the documentation etc.

[dependency-groups]
test = [

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

if you call this group dev rather than test, then uv will automatically install it when you're running tests etc. locally using uv run commands (it's treated as a "default dependency group" for local development)

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

That's why I was explicitly not naming it dev, so that it doesn't get installed by default when building docs in this doc-centric repository. But I'll defer to you what the best option is.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Oh, fair enough! I don't feel strongly

"flake8",
"flake8-bugbear",
"flake8-pyi",
]
docs = [
# Sphinx version is pinned so that new versions that introduce new warnings
# won't suddenly cause build failures. Updating the version is fine as long
# as no warnings are raised by doing so.
"sphinx==9.1.0",

# The theme used by the documentation is stored separately, so we need
# to install that as well.
"python-docs-theme",
]
3 changes: 0 additions & 3 deletions test-requirements.txt

This file was deleted.