mirror of
https://framagit.org/framasoft/framaspace/argos.git
synced 2025-04-28 18:02:41 +02:00
52 lines
1.8 KiB
Makefile
52 lines
1.8 KiB
Makefile
.DEFAULT_GOAL := help
|
|
RED=\033[0;31m
|
|
GREEN=\033[0;32m
|
|
ORANGE=\033[0;33m
|
|
BLUE=\033[0;34m
|
|
NC=\033[0m # No Color
|
|
|
|
.PHONY: test lint djlint pylint ruff
|
|
|
|
venv: ## Create the venv
|
|
python3 -m venv venv
|
|
develop: venv ## Install the dev dependencies
|
|
venv/bin/pip install -e ".[dev,docs]"
|
|
docs: cog public/mermaid.min.js ## Build the docs
|
|
venv/bin/sphinx-build docs public
|
|
sed -e 's@https://unpkg.com/mermaid[^"]*"@mermaid.min.js"@' -i public/search.html public/genindex.html
|
|
sed -e 's@https://unpkg.com/mermaid[^"]*"@../mermaid.min.js"@' -i public/developer/models.html public/developer/overview.html
|
|
public/mermaid.min.js:
|
|
curl -sL $$(grep mermaid.min.js public/search.html | cut -f 2 -d '"') --output public/mermaid.min.js
|
|
cog: ## Run cog, to integrate the CLI options to the docs.
|
|
venv/bin/cog -r docs/*.md
|
|
test: venv ## Run the tests
|
|
venv/bin/pytest
|
|
ruff: venv
|
|
venv/bin/ruff format --check .
|
|
djlint: venv ## Format the templates
|
|
venv/bin/djlint --ignore=H030,H031,H006 --profile jinja --lint argos/server/templates/*html
|
|
pylint: venv ## Runs pylint on the code
|
|
venv/bin/pylint argos
|
|
lint: djlint pylint ruff
|
|
help:
|
|
@python3 -c "$$PRINT_HELP_PYSCRIPT" < $(MAKEFILE_LIST)
|
|
|
|
# See https://daniel.feldroy.com/posts/autodocumenting-makefiles
|
|
define PRINT_HELP_PYSCRIPT # start of Python section
|
|
import re, sys
|
|
|
|
output = []
|
|
# Loop through the lines in this file
|
|
for line in sys.stdin:
|
|
# if the line has a command and a comment start with
|
|
# two pound signs, add it to the output
|
|
match = re.match(r'^([a-zA-Z_-]+):.*?## (.*)$$', line)
|
|
if match:
|
|
target, help = match.groups()
|
|
output.append("\033[36m%-25s\033[0m %s" % (target, help))
|
|
# Sort the output in alphanumeric order
|
|
output.sort()
|
|
# Print the help result
|
|
print('\n'.join(output))
|
|
endef
|
|
export PRINT_HELP_PYSCRIPT # End of python section
|