From 4b69798796feeca5dc5c13643ce39d57de11ac70 Mon Sep 17 00:00:00 2001 From: Kevin Burke Date: Sun, 17 Nov 2013 18:38:15 -0800 Subject: [PATCH 1/2] Add target to build the documentation --- Makefile | 10 ++++++++++ docs/requirements.txt | 1 + 2 files changed, 11 insertions(+) create mode 100644 docs/requirements.txt diff --git a/Makefile b/Makefile index b3152823..67c3573b 100644 --- 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 index 00000000..30491772 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +Sphinx==1.1.3 From 0c88ae42e637223cfc7f82fb37995ddfdebf199e Mon Sep 17 00:00:00 2001 From: Kevin Burke Date: Sun, 17 Nov 2013 18:39:01 -0800 Subject: [PATCH 2/2] wording --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 67c3573b..7204163d 100644 --- a/Makefile +++ b/Makefile @@ -39,4 +39,4 @@ docs-init: docs: cd docs && make html - @echo "\033[95m\n\nInstalled! Docs homepage is at docs/_build/html/index.html.\n\033[0m" + @echo "\033[95m\n\nBuild successful! View the docs homepage at docs/_build/html/index.html.\n\033[0m"