Makefile

# NOTE: Used on linux, limited support outside of Linux
#
# A simple makefile to help with small tasks related to development of Mighty
# These have been configured to only really run short tasks. Longer form tasks
# are usually completed in github actions.

.PHONY: help install-dev install check format pre-commit clean build clean-doc clean-build test doc publish

help:
	@echo "Makefile Mighty"
	@echo "* install-dev      to install all dev requirements and install pre-commit"
	@echo "* check            to check the source code for issues"
	@echo "* format           to format the code with ruff"
	@echo "* typing           to type check the code with mypy"
	@echo "* pre-commit       to run the pre-commit check"
	@echo "* clean            to clean the dist and doc build files"
	@echo "* build            to build a dist"
	@echo "* test             to run the tests"
	@echo "* docs             to serve and view the docs"
	@echo "* docs-build-only  to generate and view the html files"
	@echo "* docs-deploy      to push the latest doc version to gh-pages"
	@echo "* publish          to help publish the current branch to pypi"

PYTHON ?= .venv/bin/python
CYTHON ?= cython
PYTEST ?= $(PYTHON) -m pytest
CTAGS ?= ctags
PIP ?= uv pip
MAKE ?= make
PRECOMMIT ?= uv run pre-commit
RUFF ?= uv run ruff
MYPY ?= uv run mypy
ISORT ?= uv run isort

DIR := ${CURDIR}
DIST := ${CURDIR}/dist
DOCDIR := ${CURDIR}/docs
INDEX_HTML := file://${DOCDIR}/html/build/index.html

install-dev:
	$(PIP) install -e ".[dev,docs,pufferlib,dacbench]"
	$(PIP) install carl_bench==1.1.1 brax==0.12.1

install:
	$(PIP) install -e ".[examples]"

# pydocstyle does not have easy ignore rules, instead, we include as they are covered
check: 
	ruff format --check mighty test
	ruff check mighty test

pre-commit:
	$(PRECOMMIT) run --all-files

format: 
	$(ISORT) isort mighty test
	$(RUFF) format --silent mighty test
	$(RUFF) check --fix --silent mighty test --exit-zero
	$(RUFF) check --fix mighty test --exit-zero

typing:
	$(MYPY) mighty

test:
	$(PYTEST) -v --disable-pytest-warnings --cov=mighty test --durations=20 --cov-report html

clean-doc:
	rm -rf site

clean-build:
	rm -rf ${DIST}

# Clean up any builds in ./dist as well as doc
clean: clean-doc clean-build

# Build a distribution in ./dist
build:
	uv build

docs:
	mkdocs serve

docs-build-only:
	mkdocs build --clean --strict

docs-deploy:
	mkdocs gh-deploy --force

# Publish to testpypi
# Will echo the commands to actually publish to be run to publish to actual PyPi
# This is done to prevent accidental publishing but provide the same conveniences
publish: clean-build build
	uv publish --index testpypi
	@echo
	@echo "Test by installing from testpypi:"
	@echo "pip install --index-url https://test.pypi.org/simple/ mighty-rl"
	@echo
	@echo "Once you have decided it works, publish to actual pypi with"
	@echo "uv publish"