blob: 5293f6330ca746de9c4ccc13bfb6f3ad1fcf934b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
PYTHON ?= python3
.PHONY: all
all: style-check type-check test
.PHONY: clean
clean: clean
# clean Python cache files:
find . -name '*.pyc' -exec rm -f {} +
find . -name '*.pyo' -exec rm -f {} +
find . -name __pycache__ -exec rm -rf {} +
# clean backup files:
find . -name '*~' -exec rm -f {} +
find . -name '*.bak' -exec rm -f {} +
find . -name '*.swp' -exec rm -f {} +
find . -name '*.swo' -exec rm -f {} +
# clean generated:
find . -name '.DS_Store' -exec rm -f {} +
# clean rendered documentation :
rm -rf doc/build/
rm -rf doc/_build/
rm -rf build/sphinx/
# clean caches:
find . -name '.mypy_cache' -exec rm -rf {} +
find . -name '.ruff_cache' -exec rm -rf {} +
# clean test files:
rm -rf tests/.coverage
rm -rf tests/build
rm -rf .tox/
rm -rf .cache/
find . -name '.pytest_cache' -exec rm -rf {} +
# clean build files:
rm -rf dist/
rm -rf build/
.PHONY: style-check
style-check:
@flake8
.PHONY: type-check
type-check:
mypy sphinx
.PHONY: doclinter
doclinter:
sphinx-lint --enable line-too-long --max-line-length 85 CHANGES *.rst doc/
.PHONY: test
test:
@$(PYTHON) -X dev -X warn_default_encoding -m pytest -v $(TEST)
.PHONY: covertest
covertest:
@$(PYTHON) -X dev -X warn_default_encoding -m pytest -v --cov=sphinx --junitxml=.junit.xml $(TEST)
.PHONY: build
build:
@$(PYTHON) -m build .
.PHONY: docs
docs:
ifndef target
$(info You need to provide a target variable, e.g. `make docs target=html`.)
endif
$(MAKE) -C doc $(target)
|
