Doc tweaks

Author: inducer

TODO

@@ -0,0 +1,2 @@
+- Split out affinely mapped groups
+- p refinement

doc/mesh.rst

@@ -1,3 +1,8 @@
+Common infrastructure
+=====================
+
+.. automodule:: meshmode
+
 Mesh management
 ===============
 

doc/upload-docs.sh

@@ -0,0 +1,3 @@
+#! /bin/sh
+
+rsync --progress --verbose --archive --delete _build/html/* doc-upload:doc/meshmode

meshmode/__init__.py

@@ -0,0 +1,37 @@
+from __future__ import division
+
+__copyright__ = "Copyright (C) 2014 Andreas Kloeckner"
+
+__license__ = """
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+"""
+
+
+__doc__ = """
+.. exception:: Error
+.. exception:: ConnectivityUnavailable
+"""
+
+
+class Error(RuntimeError):
+    pass
+
+
+class ConnectivityUnavailable(Error):
+    pass

meshmode/discretization/poly_element.py

@@ -35,21 +35,16 @@
 Group types
 ^^^^^^^^^^^
 
-.. autclass:: InterpolatoryQuadratureSimplexElementGroup
+.. autoclass:: InterpolatoryQuadratureSimplexElementGroup
 .. autoclass:: QuadratureSimplexElementGroup
 .. autoclass:: PolynomialWarpAndBlendElementGroup
 
 Group factories
 ^^^^^^^^^^^^^^^
 
-.. autclass:: InterpolatoryQuadratureSimplexGroupFactory
+.. autoclass:: InterpolatoryQuadratureSimplexGroupFactory
 .. autoclass:: QuadratureSimplexGroupFactory
 .. autoclass:: PolynomialWarpAndBlendGroupFactory
-
-Discretization class
-^^^^^^^^^^^^^^^^^^^^
-
-.. autoclass:: PolynomialElementDiscretization
 """
 
 # FIXME Most of the loopy kernels will break as soon as we start using multiple

meshmode/mesh/__init__.py

@@ -27,6 +27,20 @@
 #import numpy.linalg as la
 from pytools import Record
 
+__doc__ = """
+
+.. autoclass:: MeshElementGroup
+    :members:
+    :undoc-members:
+
+.. autoclass:: Mesh
+    :members:
+    :undoc-members:
+
+.. autoclass:: ElementConnectivity
+
+"""
+
 
 # {{{ element group
 

meshmode/mesh/io.py

@@ -188,7 +188,7 @@ def read_gmsh(filename, force_ambient_dim=None):
 
 def generate_gmsh(source, dimensions, order=None, other_options=[],
         extension="geo", gmsh_executable="gmsh", force_ambient_dim=None):
-    """Run :cmd:`gmsh` on the input given by *source*, and return a
+    """Run :command:`gmsh` on the input given by *source*, and return a
     :class:`meshmode.mesh.Mesh` based on the result.
 
     :arg source: an instance of either :class:`FileSource` or