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 5bda8c9..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,6 +38,7 @@ PDOC := $(BIN)/pdoc PEP8 := $(BIN)/pep8 PEP257 := $(BIN)/pep257 PYLINT := $(BIN)/pylint +PYREVERSE := $(BIN)/pyreverse$(BAT) NOSE := $(BIN)/nosetests # Development Installation ################################################### @@ -73,7 +75,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 +91,13 @@ apidocs: .depends-ci apidocs/$(PACKAGE)/index.html apidocs/$(PACKAGE)/index.html: $(SOURCES) $(PYTHON) $(PDOC) --html --overwrite $(PACKAGE) --html-dir apidocs +.PHONY: uml +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 $(OPEN) apidocs/$(PACKAGE)/index.html @@ -148,7 +157,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: 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