Merge pull request #588 from enthought/doc/basic-pelican-webpage

Add pelican-based webpage

Author: kwmsmith

.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 #
 ###################################

.travis.yml

@@ -21,6 +21,7 @@ before_install:
     - conda create -q -n test-environment python=$PYVERSION setuptools pip numpy=1.8.1 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

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

docs/source/index.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

docs/Makefile docs/sphinx/Makefiledocs/Makefile renamed to docs/sphinx/Makefile

@@ -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.

docs/make.bat docs/sphinx/make.batdocs/make.bat renamed to docs/sphinx/make.bat

@@ -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