Update docstrings to reflect documentation changes

[linpy.git] / Makefile

diff --git a/Makefile b/Makefile
index 6bc97f3..735d08a 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -1,18 +1,18 @@
-NAME=pypol
+NAME=linpy
 
 PYTHON=python3
-PIP=pip3
-VIRTUALENV=pyvenv
 SETUP=$(PYTHON) setup.py
 RM=rm -rf
 
 .PHONY: default
 default:
-       @echo "$(NAME) – A polyhedral library based on ISL"
+       @echo "$(NAME) – A polyhedral library based on isl"
        @echo
        @echo "Makefile usage:"
        @echo "  make build            build the extension modules"
        @echo "  make test             run the test suite"
+       @echo "  make doc              generate the documentation"
+       @echo "  make view_doc         open the documentation index"
        @echo "  make clean            remove the generated files"
 
 .PHONY: build
@@ -21,10 +21,18 @@ build:
 
 .PHONY: test
 test: build
-       $(PYTHON) -m unittest
+       $(PYTHON) -m unittest -v
+
+.PHONY: doc
+doc:
+       $(MAKE) -C doc html
+
+.PHONY: view_doc
+view_doc: doc
+       xdg-open doc/_build/html/index.html >/dev/null 2>&1
 
 .PHONY: clean
 clean:
-       $(RM) build dist MANIFEST venv
-       $(RM) $(NAME).egg-info $(NAME)/_isl.*.so $(NAME)/__pycache__
-       $(RM) tests/__pycache__
+       $(RM) build dist MANIFEST venv $(NAME).egg-info $(NAME)/_islhelper.*.so
+       find . -name __pycache__ | xargs $(RM)
+       $(MAKE) -C doc $@