Skip to content

Add UML diagram generation. #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 1, 2014
Merged

Add UML diagram generation. #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2bf37fb
added uml entry to the Makefile, added Graphviz as a developer requir…
Mar 31, 2014
b40fe4a
Added `.depends-dev` dependency. Fixed rebuild and clean.
jacebrowning Mar 31, 2014
8e317ae
Added .bat extension to pyreverse for Windows.
jacebrowning Mar 31, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ env
apidocs
docs/*.html
*.rst
docs/*.png

# Google Drive
*.gdoc
Expand Down
13 changes: 11 additions & 2 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 ###################################################
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down