.gitignore

@@ -40,3 +40,7 @@ dist
 .gdb_history
 .DS_Store?
 Icon?
+
+# documentation files
+docs/source/generated
+docs/source/generated-notebooks

README.md

@@ -0,0 +1,17 @@
+Ibis
+===
+
+Ibis is a Python data analysis library enabling a 100% Python user workflow on
+top of big data systems for maximum performance and scalability. It was
+co-created by the creator of pandas (github.com/pydata/pandas) and designed to
+have a familiar user interface for folks used to small data on single machines
+in Python.
+
+Ibis targets Impala (github.com/cloudera/impala) as a first class execution
+engine, but may grow to encompass other backend systems in the future.
+
+Learn much more at http://ibis-project.org
+
+Install ibis from PyPI with:
+
+    $ pip install ibis-framework

dev/merge-pr.py

@@ -30,6 +30,7 @@
 import subprocess
 import sys
 import urllib2
+import textwrap
 
 IBIS_HOME = os.path.abspath(__file__).rsplit("/", 2)[0]
 PROJECT_NAME = 'ibis'
@@ -67,10 +68,22 @@ def fail(msg):
 
 
 def run_cmd(cmd):
-    if isinstance(cmd, list):
-        return subprocess.check_output(cmd)
-    else:
-        return subprocess.check_output(cmd.split(" "))
+    # py2.6 does not have subprocess.check_output
+    if isinstance(cmd, basestring):
+        cmd = cmd.split(' ')
+
+    popenargs = [cmd]
+    kwargs = {}
+
+    process = subprocess.Popen(stdout=subprocess.PIPE, *popenargs)
+    output, unused_err = process.communicate()
+    retcode = process.poll()
+    if retcode:
+        cmd = kwargs.get("args")
+        if cmd is None:
+            cmd = popenargs[0]
+        raise subprocess.CalledProcessError(retcode, cmd, output=output)
+    return output
 
 
 def continue_maybe(prompt):
@@ -123,7 +136,7 @@ def merge_pr(pr_num, target_ref):
 
     merge_message_flags += ["-m", title]
     if body != None:
-        merge_message_flags += ["-m", body]
+        merge_message_flags += ["-m", '\n'.join(textwrap.wrap(body))]
 
     authors = "\n".join(["Author: %s" % a for a in distinct_authors])
 

docs/Makefile

@@ -48,6 +48,7 @@ help:
 
 clean:
 	rm -rf $(BUILDDIR)/*
+	rm -rf source/generated
 
 html:
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@@ -175,3 +176,22 @@ pseudoxml:
 	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
 	@echo
 	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
+
+
+BASEDIR=$(CURDIR)
+OUTPUTDIR=$(BASEDIR)/build/html
+DEPLOYREPOSITORY=docs.ibis-project.org
+
+deploy: html
+	if test -d build; \
+	then echo " (build directory exists)"; \
+	else mkdir -p build; \
+	fi
+	if test -d build/$(DEPLOYREPOSITORY); \
+	then echo "  (repository directory exists)"; \
+	else cd build && git clone git@github.com:cloudera/$(DEPLOYREPOSITORY).git; \
+	fi
+	cd build/$(DEPLOYREPOSITORY) && git pull
+	rsync -r $(OUTPUTDIR)/* build/$(DEPLOYREPOSITORY)/
+	cd build/$(DEPLOYREPOSITORY) && git add . && git commit -m "deploy"
+	cd build/$(DEPLOYREPOSITORY) && git push origin gh-pages

docs/build-notebooks.py

@@ -0,0 +1,42 @@
+import os
+import shutil
+import subprocess
+import glob
+
+
+def rstify_notebook(path, outpath):
+    cmd = ('ipython nbconvert --execute --to=rst {0} --output {1}'
+           .format(path, outpath))
+
+    print cmd
+    subprocess.check_call(cmd, shell=True)
+
+path = '../../ibis-notebooks/basic-tutorial'
+notebooks = sorted(glob.glob(os.path.join(path, '*.ipynb')))
+
+outdir = 'source/generated-notebooks'
+if os.path.exists(outdir):
+    shutil.rmtree(outdir)
+os.mkdir(outdir)
+
+with open(os.path.join(outdir, 'manifest.txt'), 'w') as manifest:
+    for i, path in enumerate(notebooks):
+        base, tail = os.path.split(path)
+
+        root, _ = os.path.splitext(tail)
+
+        fpath = '{0}.rst'.format(i)
+        outpath = os.path.join(outdir, fpath)
+        rstify_notebook(path, outpath)
+
+        stub = """\
+Notebook {0}
+
+.. toctree::
+   :maxdepth: 1
+
+   generated-notebooks/{1}
+
+""".format(i + 1, i)
+
+        manifest.write(stub)

docs/source/_templates/layout.html

@@ -0,0 +1,15 @@
+{% extends "!layout.html" %}
+
+{% block footer %}
+{{ super() }}
+<script>
+  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+  })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+  ga('create', 'UA-65303298-2', 'auto');
+  ga('send', 'pageview');
+
+</script>
+{% endblock %}