From d353b6ac6a63b5402ee033004537f2cb9b33f931 Mon Sep 17 00:00:00 2001
From: Andreas Kloeckner <inform@tiker.net>
Date: Sun, 5 Jul 2020 18:21:26 -0500
Subject: [PATCH] Add some haphazard docs for grudge.eager
---
doc/conf.py | 2 +-
doc/index.rst | 1 +
grudge/eager.py | 17 +++++++++++++++++
3 files changed, 19 insertions(+), 1 deletion(-)
diff --git a/doc/conf.py b/doc/conf.py
index 6bb94873..d75d2aa2 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -325,6 +325,6 @@ intersphinx_mapping = {
'https://documen.tician.de/modepy/': None,
'https://documen.tician.de/pymbolic/': None,
'https://documen.tician.de/meshmode/': None,
- #'http://documen.tician.de/loopy/': None,
+ 'http://documen.tician.de/loopy/': None,
}
autoclass_content = "both"
diff --git a/doc/index.rst b/doc/index.rst
index b996c470..6d7782bc 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -8,6 +8,7 @@ Contents:
misc
symbolic
+ eager
Indices and Tables
diff --git a/grudge/eager.py b/grudge/eager.py
index 2000ef0c..43d73a4d 100644
--- a/grudge/eager.py
+++ b/grudge/eager.py
@@ -35,6 +35,11 @@ from grudge import sym, bind
from meshmode.mesh import BTAG_ALL, BTAG_NONE # noqa
+__doc__ = """
+.. autoclass:: EagerDGDiscretization
+"""
+
+
def with_queue(queue, ary):
return with_object_array_or_scalar(
lambda x: x.with_queue(queue), ary)
@@ -45,6 +50,18 @@ def without_queue(ary):
class EagerDGDiscretization(DGDiscretizationWithBoundaries):
+ """
+ .. automethod:: project
+ .. automethod:: nodes
+ .. automethod:: grad
+ .. automethod:: div
+ .. automethod:: weak_grad
+ .. automethod:: weak_div
+ .. automethod:: normal
+ .. automethod:: inverse_mass
+ .. automethod:: face_mass
+ """
+
def interp(self, src, tgt, vec):
from warnings import warn
warn("using 'interp' is deprecated, use 'project' instead.",
--
GitLab