Makefile

lint:
	@flake8 cereeberus/

format:
	@black cereeberus/

.PHONY: docs
docs:
	# Running sphinx-build to build html files in build folder.
	rm -rf docs
	mkdir -p docs
	sphinx-build -M html doc_source docs
	rsync -a docs/html/ docs/
	rm -rf docs/html

.PHONY: docs-execute
docs-execute:
	# Running sphinx-build and forcing nbsphinx to execute all notebooks.
	rm -rf docs
	mkdir -p docs
	sphinx-build -M html doc_source docs -D nbsphinx_execute=always
	rsync -a docs/html/ docs/
	rm -rf docs/html

install-editable:
	@pip install -e .

release:
	python -m build

.PHONY: tests
tests:
	# Running unittests
	@python -m unittest

install-requirements:
	@pip install -r requirements.txt

.PHONY: conda-env
conda-env:
	@conda create -y -n cereeberus python=3.12
	@conda run -n cereeberus pip install -r requirements.txt
	@conda run -n cereeberus pip install -e .

all: install-requirements install-editable format tests docs 

help: 
	@echo "Makefile commands:"
	@echo "  make lint                - Run flake8 linter on the code"
	@echo "  make format              - Format code using black"
	@echo "  make install-editable     - Install the package in editable mode for development"
	@echo "  make docs                - Build the documentation in the docs/ folder"
	@echo "  make docs-execute        - Build docs and execute all notebooks"
	@echo "  make release             - Build the package for release"
	@echo "  make tests               - Run the unit tests"
	@echo "  make install-requirements- Install all dependencies from requirements.txt"
	@echo "  make conda-env            - Create conda env, install requirements, and install package"
	@echo "  make all       - Run format, tests, docs, and release"
	@echo "  make help      - Show this help message"