Skip to content

Commit 21aa47c

Browse files
Merge pull request #2728 from VWS-Python/remove-docs-makefile
Remove docs/Makefile and use sphinx-build directly
2 parents cd1234b + 6154730 commit 21aa47c

File tree

3 files changed

+6
-27
lines changed

3 files changed

+6
-27
lines changed

.pre-commit-config.yaml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -323,7 +323,8 @@ repos:
323323
stages: [pre-commit]
324324
- id: linkcheck
325325
name: linkcheck
326-
entry: make -C docs/ linkcheck SPHINXOPTS=-W
326+
entry: uv run --extra=dev sphinx-build -M linkcheck docs/source docs/build
327+
-W
327328
language: python
328329
types_or: [rst]
329330
stages: [manual]
@@ -332,7 +333,8 @@ repos:
332333

333334
- id: spelling
334335
name: spelling
335-
entry: make -C docs/ spelling SPHINXOPTS=-W
336+
entry: uv run --extra=dev sphinx-build -M spelling docs/source docs/build
337+
-W
336338
language: python
337339
types_or: [rst]
338340
stages: [manual]
@@ -341,7 +343,7 @@ repos:
341343

342344
- id: docs
343345
name: Build Documentation
344-
entry: make docs
346+
entry: uv run --extra=dev sphinx-build -M html docs/source docs/build -W
345347
language: python
346348
stages: [manual]
347349
pass_filenames: false

Makefile

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
11
SHELL := /bin/bash -euxo pipefail
2-
3-
# Treat Sphinx warnings as errors
4-
SPHINXOPTS := -W
5-
62
.PHONY: update-secrets
73
update-secrets:
84
# After updating secrets, commit the new secrets.tar.gpg file.
@@ -11,7 +7,7 @@ update-secrets:
117

128
.PHONY: docs
139
docs:
14-
make -C docs clean html SPHINXOPTS=$(SPHINXOPTS)
10+
uv run --extra=dev sphinx-build -M html docs/source docs/build -W
1511

1612
.PHONY: open-docs
1713
open-docs:

docs/Makefile

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

0 commit comments

Comments
 (0)