Docstrings

[linpy.git] / Makefile

diff --git a/Makefile b/Makefile
index e38f79b..11f63e1 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -1,8 +1,6 @@
-NAME=pypol
+NAME=linpy
 
 PYTHON=python3
-PIP=pip3
-VIRTUALENV=pyvenv
 SETUP=$(PYTHON) setup.py
 RM=rm -rf
 
@@ -13,6 +11,8 @@ default:
        @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
@@ -23,7 +23,16 @@ build:
 test: build
        $(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 $(NAME).egg-info $(NAME)/_islhelper.*.so
        find . -name __pycache__ | xargs $(RM)
+       $(MAKE) -C doc $@