Merge pull request #487 from ketch/run_doctests

Modify Travis script to run doctests.

Author: mandli

.travis.yml

@@ -44,6 +44,10 @@ script:
   - if [[ "${TEST_PACKAGE}" == "petclaw" ]]; then
        mpirun -n 4 ${CLAWPACK}/petsc4py_stack/bin/nosetests -v;
     fi
+  # Run doctests
+  - cd ../src/pyclaw
+  - nosetests --first-pkg-wins --with-doctest --exclude=example --exclude=limiters --exclude=sharpclaw --exclude=io
+
 
 after_success:
   - coveralls

cleanup_examples.py

@@ -1,32 +1,35 @@
+#!/usr/bin/env python
 
-#
-# Cleans up by deleting object files, executable, and _output directory.
-# Use after run_examples to clean up stuff not needed on webpages.
+r"""
+Cleans up by deleting object files, executable, and _output directory.
+"""
 
 import os,sys,glob
 import shutil
 
-examples_dir = os.path.abspath('./examples')
-print "Will remove all _output, _plots, and build directories from ",examples_dir
-ans = raw_input("Ok? ")
-if ans.lower() not in ['y','yes']:
-    print "Aborting."
-    sys.exit()
+if __name__ == "__main__":
 
-os.chdir(examples_dir)
-exdirlist = []
-for (dirpath, subdirs, files) in os.walk('.'):
-    currentdir = os.path.abspath(os.getcwd())
-    os.chdir(os.path.abspath(dirpath))
-    
-    print 'In directory ',dirpath
-    
-    if os.path.isdir('_output'):
-        shutil.rmtree('./_output')
-    if os.path.isdir('_plots'):
-        shutil.rmtree('./_plots')
-    if os.path.isdir('build'):
-        shutil.rmtree('./build')
+    examples_dir = os.path.abspath('./examples')
+    print "Will remove all _output, _plots, and build directories from ",examples_dir
+    ans = raw_input("Ok? ")
+    if ans.lower() not in ['y','yes']:
+        print "Aborting."
+        sys.exit()
+
+    os.chdir(examples_dir)
+    exdirlist = []
+    for (dirpath, subdirs, files) in os.walk('.'):
+        currentdir = os.path.abspath(os.getcwd())
+        os.chdir(os.path.abspath(dirpath))
+        
+        print 'In directory ',dirpath
 
-    os.chdir(currentdir)
+        if os.path.isdir('_output'):
+            shutil.rmtree('./_output')
+        if os.path.isdir('_plots'):
+            shutil.rmtree('./_plots')
+        if os.path.isdir('build'):
+            shutil.rmtree('./build')
+            
+        os.chdir(currentdir)
 

src/pyclaw/solver.py

@@ -34,9 +34,9 @@ class Solver(object):
     Solver initialization takes one argument -- a Riemann solver:
 
         >>> from clawpack import pyclaw, riemann
-        >>> solver = pyclaw.ClawSolver2D(riemann.rp2_euler_4wave)
+        >>> solver = pyclaw.ClawSolver2D(riemann.euler_4wave_2D)
 
-    After which solver options may be set.
+    after which solver options may be set.
     It is necessary to set the boundary conditions (for q, and
     for aux if an aux array is used):