File tree Expand file tree Collapse file tree 1 file changed +26
-1
lines changed Expand file tree Collapse file tree 1 file changed +26
-1
lines changed Original file line number Diff line number Diff line change 2828
2929from .._deprecation import warn_deprecated
3030from ..ugrid .load import PARSE_UGRID_ON_LOAD , load_mesh , load_meshes
31- from ..ugrid .mesh import Connectivity , Mesh , MeshCoord
31+ from ..ugrid .mesh import Connectivity as _Connectivity
32+ from ..ugrid .mesh import Mesh as _Mesh
33+ from ..ugrid .mesh import MeshCoord as _MeshCoord
3234from ..ugrid .save import save_mesh
3335from ..ugrid .utils import recombine_submeshes
3436
37+
38+ # NOTE: publishing the original Mesh, MeshCoord and Connectivity here causes a Sphinx
39+ # Sphinx warning, E.G.:
40+ # "WARNING: duplicate object description of iris.ugrid.mesh.Mesh, other instance
41+ # in generated/api/iris.experimental.ugrid, use :no-index: for one of them"
42+ # For some reason, this only happens for the classes, and not the functions.
43+ #
44+ # This is a fatal problem, i.e. breaks the build since we are building with -W.
45+ # We couldn't fix this with "autodoc_suppress_warnings", so the solution for now is to
46+ # wrap the classes. Which is really ugly.
47+ # TODO: remove this when we remove iris.experimental.ugrid
48+ class Mesh (_Mesh ):
49+ pass
50+
51+
52+ class MeshCoord (_MeshCoord ):
53+ pass
54+
55+
56+ class Connectivity (_Connectivity ):
57+ pass
58+
59+
3560__all__ = [
3661 "Connectivity" ,
3762 "Mesh" ,
You can’t perform that action at this time.
0 commit comments