enthought · kwmsmith · Sep 17, 2014 · Sep 4, 2014 · Sep 5, 2014 · Sep 5, 2014
diff --git a/.gitignore b/.gitignore
@@ -98,8 +98,9 @@ Thumbs.db
 
 # Documentation generated files #
 #################################
-doc/frontpage/build
-doc/source/generated
+docs/sphinx/build/*
+docs/www/output/*
+docs/www/cache/*
 
 # Things specific to this project #
 ###################################

diff --git a/.travis.yml b/.travis.yml
@@ -21,6 +21,7 @@ before_install:
     - conda create -q -n test-environment python=$PYVERSION setuptools pip numpy pyzmq ipython matplotlib cython sphinx mock coverage requests pyyaml
     - source activate test-environment
     - pip install sphinxcontrib-napoleon sphinxcontrib-programoutput coveralls
+    - pip install pelican
     - if [[ "$PYVERSION" == "2.7" ]]; then
           conda install mpi4py;
       else
@@ -30,8 +31,9 @@ before_install:
     - sudo apt-get install libhdf5-mpich2-7 libhdf5-mpich2-dev  # from Nick Andrik's PPA
     - CC=mpicc pip install git+https://github.com/h5py/[email protected] --install-option="--mpi"
 install:
-    - python setup.py install
-    - (cd $TRAVIS_BUILD_DIR && cd docs && make html)
+    - python setup.py install  # build DistArray
+    - (cd $TRAVIS_BUILD_DIR/docs/sphinx && make html)  # build docs
+    - (cd $TRAVIS_BUILD_DIR/docs/www && make html)  # build docs
 before_script:
     - "export DISPLAY=:99.0"  # for plotting.py
     - "sh -e /etc/init.d/xvfb start"  # for plotting.py

diff --git a/Makefile b/Makefile
@@ -114,7 +114,8 @@ clean:
 	-${PYTHON} setup.py clean --all
 	-find . \( -iname '*.py[co]' -or -iname '*.so' -or -iname '*.c' -or -iname '__pycache__' -or -iname '.ipynb_checkpoints' \) -exec ${RM} -r '{}' +
 	-${RM} -r ${PARALLEL_OUT_DIR} build coverage_report examples/julia_set/build
-	-${MAKE} clean -C docs
+	-${MAKE} clean -C docs/sphinx
+	-${MAKE} clean -C docs/www
 .PHONY: clean
 
 cleanall: clean

diff --git a/docs/source/index.rst b/docs/source/index.rst
diff --git a/docs/Makefile → docs/sphinx/Makefile b/docs/Makefile → docs/sphinx/Makefile
diff --git a/docs/make.bat → docs/sphinx/make.bat b/docs/make.bat → docs/sphinx/make.bat
diff --git a/docs/requirements.txt → docs/sphinx/requirements.txt b/docs/requirements.txt → docs/sphinx/requirements.txt
diff --git a/docs/sphinx/source/blurb.rst b/docs/sphinx/source/blurb.rst
@@ -0,0 +1,28 @@
+*Think globally, act locally.*
+
+DistArray provides general multidimensional NumPy-like distributed arrays to
+Python.  It intends to bring the strengths of NumPy to data-parallel
+high-performance computing.  DistArray has a similar API to `NumPy`_.
+
+DistArray is ready for real-world testing and deployment; however, the project
+is still evolving rapidly, and we appreciate continued input from the
+scientific-Python community.
+
+DistArray is for users who
+
+* know and love Python and NumPy,
+* want to scale NumPy to larger distributed datasets,
+* want to interactively play with distributed data but also
+* want to run batch-oriented distributed programs;
+* want an easier way to drive and coordinate existing MPI-based codes,
+* have a lot of data that may already be distributed,
+* want a global view ("think globally") with local control ("act locally"),
+* need to tap into existing parallel libraries like Trilinos, PETSc, or
+  Elemental,
+* want the interactivity of IPython and the performance of MPI.
+
+DistArray is designed to work with other packages that implement the
+`Distributed Array Protocol`_.
+
+.. _Distributed Array Protocol: http://distributed-array-protocol.readthedocs.org
+.. _NumPy: http://www.numpy.org
diff --git a/docs/sphinx/source/build-the-docs.rst b/docs/sphinx/source/build-the-docs.rst
@@ -0,0 +1,24 @@
+Building the docs
+-----------------
+
+Dependencies to build the documentation:
+
+* Sphinx
+* sphinxcontrib.napoleon
+* sphinxcontrib.programoutput
+
+If you have the dependencies listed above, and you want to build the
+documentation (also available at http://distarray.readthedocs.org), navigate to
+the ``docs/sphinx`` subdirectory of the DistArray source and use the Makefile there.
+
+For example, to build the html documentation::
+
+    make html
+
+from the ``docs`` directory.
+
+Try::
+
+    make help
+
+for more options.
diff --git a/docs/source/conf.py → docs/sphinx/source/conf.py b/docs/source/conf.py → docs/sphinx/source/conf.py
@@ -137,7 +137,7 @@
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+html_logo = "../../../docs/www/output/images/distarray-logo.png"
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32

diff --git a/docs/sphinx/source/contact-us.rst b/docs/sphinx/source/contact-us.rst
@@ -0,0 +1,9 @@
+Contact Us
+----------
+
+If you have questions or would like to contribute, contact us
+
+* on the DistArray mailing list:  [email protected],
+* in the DistArray IRC channel: #distarray on freenode, or
+* through the DistArray GitHub repo: https://github.com/enthought/distarray
+  (for bug reports and pull requests).
diff --git a/docs/source/distarray.apps.rst → docs/sphinx/source/distarray.apps.rst b/docs/source/distarray.apps.rst → docs/sphinx/source/distarray.apps.rst
diff --git a/docs/source/distarray.globalapi.rst → docs/sphinx/source/distarray.globalapi.rst b/docs/source/distarray.globalapi.rst → docs/sphinx/source/distarray.globalapi.rst
diff --git a/docs/source/distarray.localapi.rst → docs/sphinx/source/distarray.localapi.rst b/docs/source/distarray.localapi.rst → docs/sphinx/source/distarray.localapi.rst
diff --git a/docs/source/distarray.plotting.rst → docs/sphinx/source/distarray.plotting.rst b/docs/source/distarray.plotting.rst → docs/sphinx/source/distarray.plotting.rst
diff --git a/docs/source/distarray.rst → docs/sphinx/source/distarray.rst b/docs/source/distarray.rst → docs/sphinx/source/distarray.rst
diff --git a/docs/source/environment-modules-notes.rst → ...hinx/source/environment-modules-notes.rst b/docs/source/environment-modules-notes.rst → ...hinx/source/environment-modules-notes.rst
diff --git a/docs/sphinx/source/getting-started.rst b/docs/sphinx/source/getting-started.rst
@@ -0,0 +1,9 @@
+Getting Started
+---------------
+
+To see some examples of what DistArray can do, check out our IPython notebooks
+on nbviewer (also in the ``examples`` directory of the DistArray source).
+
+* `DistArray Features <http://nbviewer.ipython.org/github/enthought/distarray/blob/master/examples/features.ipynb>`_ 
+* `Seismic Volume <http://nbviewer.ipython.org/github/enthought/distarray/blob/master/examples/seismic_volume/seismic_volume.ipynb>`_
+* `Julia Set <http://nbviewer.ipython.org/github/enthought/distarray/blob/master/examples/julia_set/julia_set.ipynb>`_
diff --git a/docs/source/hdf5-notes.rst → docs/sphinx/source/hdf5-notes.rst b/docs/source/hdf5-notes.rst → docs/sphinx/source/hdf5-notes.rst
diff --git a/docs/sphinx/source/history.rst b/docs/sphinx/source/history.rst
@@ -0,0 +1,7 @@
+History
+-------
+
+DistArray was started by Brian Granger in 2008 and is currently being developed
+at Enthought by a team led by Kurt Smith, in partnership with Bill Spotz from
+Sandia's (Py)Trilinos project and Brian Granger and Min RK from the IPython
+project.
diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst
@@ -0,0 +1,46 @@
+.. DistArray documentation master file, created by
+   sphinx-quickstart on Fri Jan 31 01:11:34 2014.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+
+DistArray |version|
+===================
+
+.. include:: blurb.rst
+.. include:: getting-started.rst
+.. include:: overview.rst
+.. include:: installation.rst
+.. include:: build-the-docs.rst
+.. include:: history.rst
+.. include:: contact-us.rst
+
+
+Other Documentation
+-------------------
+
+.. toctree::
+   :maxdepth: 1
+
+   DistArray API Reference <distarray.rst>
+   The Distributed Array Protocol <http://distributed-array-protocol.readthedocs.org>
+   Notes on building HDF5 and h5py <hdf5-notes.rst>
+   Notes on building environment-modules <environment-modules-notes.rst>
+   Licensing for bundled `six` module (Python 2 / 3 compatibility) <six-license.rst>
+
+
+Release Notes
+-------------
+.. toctree::
+   :maxdepth: 1
+   :glob:
+
+   releases/*
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/sphinx/source/installation.rst b/docs/sphinx/source/installation.rst
@@ -0,0 +1,51 @@
+Installation
+------------
+
+DistArray requires the following Python libraries:
+
+* `NumPy`_,
+* `IPython`_, and
+* `Mpi4Py`_.
+
+.. _NumPy: http://www.numpy.org
+.. _IPython: http://ipython.org
+.. _Mpi4Py: http://mpi4py.scipy.org
+
+Optionally, DistArray can make use of:
+
+* `h5py`_ built against a parallel-enabled build of HDF5 (for HDF5 IO), and
+* `matplotlib`_ (for making plots of DistArray distributions).
+
+.. _h5py: http://www.h5py.org/
+.. _matplotlib: http://matplotlib.org/
+
+If you have the above, you should be able to install DistArray with::
+
+    python setup.py install
+
+or::
+
+    pip install distarray
+
+
+Testing Your Installation
+-------------------------
+
+To test your installation, you will first need to start an IPython.parallel
+cluster with MPI enabled.  The easist way is to use use the ``dacluster``
+command that comes with DistArray::
+
+    dacluster start
+
+See ``dacluster``'s help for more::
+
+    dacluster --help
+
+You should then be able to run all the tests from the DistArray source
+directory with::
+
+    make test
+
+or from anywhere with::
+
+    python -m distarray.run_tests