Skip to content

Commit f8896df

Browse files
committed
Add Makefile
1 parent ec56a01 commit f8896df

File tree

2 files changed

+88
-0
lines changed

2 files changed

+88
-0
lines changed

.codespell-ignore-words.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
# Python terms
22
pytest
33
codespell
4+
sphinxcontrib

Makefile

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
#
2+
# Colors
3+
#
4+
5+
# Define ANSI color codes
6+
RESET_COLOR = \033[m
7+
8+
BLUE = \033[1;34m
9+
YELLOW = \033[1;33m
10+
GREEN = \033[1;32m
11+
RED = \033[1;31m
12+
BLACK = \033[1;30m
13+
MAGENTA = \033[1;35m
14+
CYAN = \033[1;36m
15+
WHITE = \033[1;37m
16+
17+
DBLUE = \033[0;34m
18+
DYELLOW = \033[0;33m
19+
DGREEN = \033[0;32m
20+
DRED = \033[0;31m
21+
DBLACK = \033[0;30m
22+
DMAGENTA = \033[0;35m
23+
DCYAN = \033[0;36m
24+
DWHITE = \033[0;37m
25+
26+
BG_WHITE = \033[47m
27+
BG_RED = \033[41m
28+
BG_GREEN = \033[42m
29+
BG_YELLOW = \033[43m
30+
BG_BLUE = \033[44m
31+
BG_MAGENTA = \033[45m
32+
BG_CYAN = \033[46m
33+
34+
# Name some of the colors
35+
COM_COLOR = $(DBLUE)
36+
OBJ_COLOR = $(DCYAN)
37+
OK_COLOR = $(DGREEN)
38+
ERROR_COLOR = $(DRED)
39+
WARN_COLOR = $(DYELLOW)
40+
NO_COLOR = $(RESET_COLOR)
41+
42+
OK_STRING = "[OK]"
43+
ERROR_STRING = "[ERROR]"
44+
WARN_STRING = "[WARNING]"
45+
46+
define banner
47+
@echo " $(WHITE)__________$(RESET_COLOR)"
48+
@echo "$(WHITE) |$(DWHITE) PALEWIRE $(RESET_COLOR)$(WHITE)|$(RESET_COLOR)"
49+
@echo "$(WHITE) |&&& ======|$(RESET_COLOR)"
50+
@echo "$(WHITE) |=== ======|$(RESET_COLOR) $(DWHITE)This is a $(RESET_COLOR)$(DBLACK)$(BG_WHITE)palewire$(RESET_COLOR)$(DWHITE) automation$(RESET_COLOR)"
51+
@echo "$(WHITE) |=== == %%%|$(RESET_COLOR)"
52+
@echo "$(WHITE) |[_] ======|$(RESET_COLOR) $(1)"
53+
@echo "$(WHITE) |=== ===!##|$(RESET_COLOR)"
54+
@echo "$(WHITE) |__________|$(RESET_COLOR)"
55+
@echo ""
56+
endef
57+
58+
#
59+
# Python helpers
60+
#
61+
62+
UV := uv run
63+
PYTHON := python -W ignore -m
64+
65+
#
66+
# Commands
67+
#
68+
69+
serve-docs: ## Test the site
70+
$(call banner, 🧪 Serving test site 🧪)
71+
@rm -rf _build/
72+
@rm -rf docs/_build
73+
@cd docs && $(UV) make livehtml
74+
75+
#
76+
# Extras
77+
#
78+
79+
80+
help: ## Show this help. Example: make help
81+
@egrep -h '\s##\s' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
82+
83+
84+
# Mark all the commands that don't have a target
85+
.PHONY: help \
86+
format \
87+
serve

0 commit comments

Comments
 (0)