Skip to content
Snippets Groups Projects
Commit 552aff8d authored by Andreas Klöckner's avatar Andreas Klöckner
Browse files

Re-document EagerDGDiscretization to avoid breaking mirgecom doc build

parent 2352a787
No related branches found
No related tags found
No related merge requests found
...@@ -4,9 +4,3 @@ Discretization ...@@ -4,9 +4,3 @@ Discretization
.. module:: grudge .. module:: grudge
.. automodule:: grudge.discretization .. automodule:: grudge.discretization
Discretization with Eager Evaluation
====================================
.. automodule:: grudge.eager
...@@ -139,3 +139,7 @@ AK also gratefully acknowledges a hardware gift from Nvidia Corporation. ...@@ -139,3 +139,7 @@ AK also gratefully acknowledges a hardware gift from Nvidia Corporation.
The views and opinions expressed herein do not necessarily reflect those of the The views and opinions expressed herein do not necessarily reflect those of the
funding agencies. funding agencies.
Deprecated functionality
========================
.. automodule:: grudge.eager
"""
.. autoclass:: EagerDGDiscretization
"""
__copyright__ = "Copyright (C) 2020 Andreas Kloeckner" __copyright__ = "Copyright (C) 2020 Andreas Kloeckner"
__license__ = """ __license__ = """
...@@ -26,9 +29,10 @@ from grudge.discretization import DiscretizationCollection ...@@ -26,9 +29,10 @@ from grudge.discretization import DiscretizationCollection
class EagerDGDiscretization(DiscretizationCollection): class EagerDGDiscretization(DiscretizationCollection):
""" """
Inherits from :class:`~grudge.discretization.DiscretizationCollection`. This class is deprecated and only part of the documentation in order to
avoid breaking depending documentation builds.
.. automethod:: __init__ Use :class:`~grudge.discretization.DiscretizationCollection` instead in
new code.
""" """
def __init__(self, *args, **kwargs): def __init__(self, *args, **kwargs):
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment