Merge 1e08687 into b8c6732

appliedsec · Feb 2, 2014 · 397f36b · 397f36b
2 parents b8c6732 + 1e08687
commit 397f36b
Show file tree

Hide file tree

Showing 39 changed files with 494 additions and 7,232 deletions.
diff --git a/.gitignore b/.gitignore
@@ -9,4 +9,4 @@ pygeoip-*
 cover
 .coverage
 .coveralls.yml
-apidocs/html/.*
+docs/_build/*
diff --git a/DEVELOPER.md b/DEVELOPER.md
@@ -1,5 +1,5 @@
 # Bootstrap manual for developers
-_Dependencies: tox, nose, epydoc_
+_Dependencies: tox, nose_
 
 ### Testing
 
@@ -20,10 +20,6 @@ This requires a machine with Python 2.5 - 3.3 installed and all dependencies men
 
 ### Documentation
 
-The documentation can be re-generated by running epydoc from repository root.
-
-    epydoc --config=epydoc.ini --no-private
-
 For converting Markdown to reStructuredText used by PyPi we use pandoc.
 [Read pandoc's install instructions](http://johnmacfarlane.net/pandoc/installing.html).
 

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -4,5 +4,4 @@ include README.rst
 include LICENSE.md
 include DEVELOPER.md
 include CHANGELOG.md
-include epydoc.ini
 include tox.ini
diff --git a/Makefile b/Makefile
@@ -0,0 +1,24 @@
+.PHONY: docs
+
+all: test docs
+
+test:
+	@echo "Downloading test databases"
+	rm -rf maxmind-geoip-samples.tar.gz tests/data; mkdir -p tests/data
+	curl -s https://www.defunct.cc/maxmind-geoip-samples.tar.gz | tar -zx -C tests
+
+	@echo "Testing local state"
+	@tox --version > /dev/null || (echo "Requires tox - install requirements.txt"; exit 1)
+	tox
+
+docs:
+	@echo "Building documentation"
+	make -C docs clean
+	make -C docs html
+
+clean:
+	@echo "Cleaning doc, test and cache files"
+	git clean -fd
+	find . -name *.pyc -delete
+	rm -rf pygeoip-* pygeoip.egg-info
+
diff --git a/README.md b/README.md
diff --git a/apidocs/html/api-objects.txt b/apidocs/html/api-objects.txt