Skip to content

Commit 922d7fb

Browse files
committed
Doc tweaks
1 parent dc56b8f commit 922d7fb

File tree

7 files changed

+64
-8
lines changed

7 files changed

+64
-8
lines changed

TODO

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
- Split out affinely mapped groups
2+
- p refinement

doc/mesh.rst

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
Common infrastructure
2+
=====================
3+
4+
.. automodule:: meshmode
5+
16
Mesh management
27
===============
38

doc/upload-docs.sh

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

meshmode/__init__.py

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
from __future__ import division
2+
3+
__copyright__ = "Copyright (C) 2014 Andreas Kloeckner"
4+
5+
__license__ = """
6+
Permission is hereby granted, free of charge, to any person obtaining a copy
7+
of this software and associated documentation files (the "Software"), to deal
8+
in the Software without restriction, including without limitation the rights
9+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10+
copies of the Software, and to permit persons to whom the Software is
11+
furnished to do so, subject to the following conditions:
12+
13+
The above copyright notice and this permission notice shall be included in
14+
all copies or substantial portions of the Software.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22+
THE SOFTWARE.
23+
"""
24+
25+
26+
__doc__ = """
27+
.. exception:: Error
28+
.. exception:: ConnectivityUnavailable
29+
"""
30+
31+
32+
class Error(RuntimeError):
33+
pass
34+
35+
36+
class ConnectivityUnavailable(Error):
37+
pass

meshmode/discretization/poly_element.py

+2-7
Original file line numberDiff line numberDiff line change
@@ -35,21 +35,16 @@
3535
Group types
3636
^^^^^^^^^^^
3737
38-
.. autclass:: InterpolatoryQuadratureSimplexElementGroup
38+
.. autoclass:: InterpolatoryQuadratureSimplexElementGroup
3939
.. autoclass:: QuadratureSimplexElementGroup
4040
.. autoclass:: PolynomialWarpAndBlendElementGroup
4141
4242
Group factories
4343
^^^^^^^^^^^^^^^
4444
45-
.. autclass:: InterpolatoryQuadratureSimplexGroupFactory
45+
.. autoclass:: InterpolatoryQuadratureSimplexGroupFactory
4646
.. autoclass:: QuadratureSimplexGroupFactory
4747
.. autoclass:: PolynomialWarpAndBlendGroupFactory
48-
49-
Discretization class
50-
^^^^^^^^^^^^^^^^^^^^
51-
52-
.. autoclass:: PolynomialElementDiscretization
5348
"""
5449

5550
# FIXME Most of the loopy kernels will break as soon as we start using multiple

meshmode/mesh/__init__.py

+14
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,20 @@
2727
#import numpy.linalg as la
2828
from pytools import Record
2929

30+
__doc__ = """
31+
32+
.. autoclass:: MeshElementGroup
33+
:members:
34+
:undoc-members:
35+
36+
.. autoclass:: Mesh
37+
:members:
38+
:undoc-members:
39+
40+
.. autoclass:: ElementConnectivity
41+
42+
"""
43+
3044

3145
# {{{ element group
3246

meshmode/mesh/io.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ def read_gmsh(filename, force_ambient_dim=None):
188188

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

0 commit comments

Comments
 (0)