From 2bf37fb4a7a617e5877a000eacf1c105545cd0e2 Mon Sep 17 00:00:00 2001 From: Jeff Kloosterman Date: Mon, 31 Mar 2014 13:59:06 -0400 Subject: [PATCH 1/3] added uml entry to the Makefile, added Graphviz as a developer requirement. --- Makefile | 7 ++++++- README.md | 1 + 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 5bda8c9..d8d0af5 100644 --- a/Makefile +++ b/Makefile @@ -37,6 +37,7 @@ PDOC := $(BIN)/pdoc PEP8 := $(BIN)/pep8 PEP257 := $(BIN)/pep257 PYLINT := $(BIN)/pylint +PYREVERSE := $(BIN)/pyreverse NOSE := $(BIN)/nosetests # Development Installation ################################################### @@ -73,7 +74,7 @@ $(DEPENDS_DEV): Makefile # Documentation ############################################################## .PHONY: doc -doc: readme apidocs +doc: readme apidocs uml .PHONY: readme readme: .depends-dev docs/README-github.html docs/README-pypi.html @@ -89,6 +90,10 @@ apidocs: .depends-ci apidocs/$(PACKAGE)/index.html apidocs/$(PACKAGE)/index.html: $(SOURCES) $(PYTHON) $(PDOC) --html --overwrite $(PACKAGE) --html-dir apidocs +.PHONY: uml +uml: $(SOURCES) + $(PYREVERSE) $(PACKAGE) -p $(PACKAGE) -f ALL -o png --ignore test + .PHONY: read read: doc $(OPEN) apidocs/$(PACKAGE)/index.html diff --git a/README.md b/README.md index 0df7314..554cc1e 100644 --- a/README.md +++ b/README.md @@ -64,6 +64,7 @@ Requirements * Linux: http://www.gnu.org/software/make (likely already installed) * virtualenv: https://pypi.python.org/pypi/virtualenv#installation * Pandoc: http://johnmacfarlane.net/pandoc/installing.html +* Graphviz: http://www.graphviz.org/Download.php Installation From b40fe4afdb361e61dc8b6020a42d50c23746c26a Mon Sep 17 00:00:00 2001 From: Jace Browning Date: Mon, 31 Mar 2014 19:28:40 -0400 Subject: [PATCH 2/3] Added `.depends-dev` dependency. Fixed rebuild and clean. - only rebuilding on source change - copying to docs/ - cleaning from docs/ --- .gitignore | 1 + Makefile | 7 +++++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index ab9f397..b31a107 100644 --- a/.gitignore +++ b/.gitignore @@ -15,6 +15,7 @@ env apidocs docs/*.html *.rst +docs/*.png # Google Drive *.gdoc diff --git a/Makefile b/Makefile index d8d0af5..f8a4e3a 100644 --- a/Makefile +++ b/Makefile @@ -91,8 +91,11 @@ apidocs/$(PACKAGE)/index.html: $(SOURCES) $(PYTHON) $(PDOC) --html --overwrite $(PACKAGE) --html-dir apidocs .PHONY: uml -uml: $(SOURCES) +uml: .depends-dev docs/*.png $(SOURCES) +docs/*.png: $(PYREVERSE) $(PACKAGE) -p $(PACKAGE) -f ALL -o png --ignore test + - mv -f classes_$(PACKAGE).png docs/classes.png + - mv -f packages_$(PACKAGE).png docs/packages.png .PHONY: read read: doc @@ -153,7 +156,7 @@ clean-all: clean .clean-env .PHONY: .clean-doc .clean-doc: - rm -rf apidocs docs/README*.html README.rst + rm -rf apidocs docs/README*.html README.rst docs/*.png .PHONY: .clean-test .clean-test: From 8e317aee94aaeaba66a5ff0decc7815b299925df Mon Sep 17 00:00:00 2001 From: Jace Browning Date: Mon, 31 Mar 2014 19:30:07 -0400 Subject: [PATCH 3/3] Added .bat extension to pyreverse for Windows. --- Makefile | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index f8a4e3a..42c84b0 100644 --- a/Makefile +++ b/Makefile @@ -14,6 +14,7 @@ ifneq ($(findstring win32, $(PLATFORM)), ) SYS_VIRTUALENV := C:\\Python33\\Scripts\\virtualenv.exe BIN := $(ENV)/Scripts OPEN := cmd /c start + BAT := .bat # https://bugs.launchpad.net/virtualenv/+bug/449537 export TCL_LIBRARY=C:\\Python33\\tcl\\tcl8.5 else @@ -37,7 +38,7 @@ PDOC := $(BIN)/pdoc PEP8 := $(BIN)/pep8 PEP257 := $(BIN)/pep257 PYLINT := $(BIN)/pylint -PYREVERSE := $(BIN)/pyreverse +PYREVERSE := $(BIN)/pyreverse$(BAT) NOSE := $(BIN)/nosetests # Development Installation ###################################################