Add target to build the documentation
authorKevin Burke <kevin@twilio.com>
Mon, 18 Nov 2013 02:38:15 +0000 (18:38 -0800)
committerKevin Burke <kevin@twilio.com>
Mon, 18 Nov 2013 02:38:15 +0000 (18:38 -0800)
Makefile
docs/requirements.txt [new file with mode: 0644]

index b3152823e58c2b0edf13e5ee549d3738b7a1c6c8..67c3573b9c45c388e496120b463eb56858017a16 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -1,3 +1,5 @@
+.PHONY: docs
+
 init:
        pip install -r requirements.txt
 
@@ -30,3 +32,11 @@ charade:
 publish:
        python setup.py sdist upload
        python setup.py bdist_wheel upload
+
+
+docs-init:
+       pip install -r docs/requirements.txt
+
+docs:
+       cd docs && make html
+       @echo "\033[95m\n\nInstalled! Docs homepage is at docs/_build/html/index.html.\n\033[0m"
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644 (file)
index 0000000..3049177
--- /dev/null
@@ -0,0 +1 @@
+Sphinx==1.1.3