From 91de626c494be488bbab3475a66eeec66b8d4f70 Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner <inform@tiker.net> Date: Mon, 10 Aug 2020 18:45:56 -0500 Subject: [PATCH] Fix avalanche of errors in doc build --- doc/conf.py | 2 +- doc/mesh.rst | 10 ++-------- meshmode/discretization/poly_element.py | 2 +- meshmode/discretization/visualization.py | 3 ++- meshmode/mesh/__init__.py | 4 ---- 5 files changed, 6 insertions(+), 15 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 5d9f499e..738dcfc0 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -144,7 +144,7 @@ html_sidebars = { # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = [] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied diff --git a/doc/mesh.rst b/doc/mesh.rst index cbb32279..583770e2 100644 --- a/doc/mesh.rst +++ b/doc/mesh.rst @@ -6,7 +6,7 @@ Common infrastructure Mesh management =============== -.. automodule:: meshmode.mesh +.. currentmodule:: meshmode.mesh Design of the Data Structure ---------------------------- @@ -44,13 +44,7 @@ Consider the following picture: Mesh Data Structure ------------------- -.. autoclass:: MeshElementGroup - :members: - :undoc-members: - -.. autoclass:: Mesh - :members: - :undoc-members: +.. automodule:: meshmode.mesh Mesh generation --------------- diff --git a/meshmode/discretization/poly_element.py b/meshmode/discretization/poly_element.py index f94e2970..39c3043b 100644 --- a/meshmode/discretization/poly_element.py +++ b/meshmode/discretization/poly_element.py @@ -257,7 +257,7 @@ class PolynomialRecursiveNodesElementGroup(_MassMatrixQuadratureElementGroup): polynomials in :math:`P^k`, hence usable for differentiation and interpolation. Interpolation nodes edge-clustered for avoidance of Runge phenomena. Depending on the *family* argument, nodes may be present on the - boundary of the simplex. + boundary of the simplex. See [Isaac20]_ for details. Supports a choice of the base *family* of 1D nodes, see the documentation of the *family* argument to :func:`recursivenodes.recursive_nodes`. diff --git a/meshmode/discretization/visualization.py b/meshmode/discretization/visualization.py index 72071408..16b4aeef 100644 --- a/meshmode/discretization/visualization.py +++ b/meshmode/discretization/visualization.py @@ -491,7 +491,8 @@ class Visualizer(object): :arg par_manifest_filename: If not *None* write a distributed-memory manifest with this file name if *file_name* matches the first entry in *par_file_names*. - :arg par_file_names + :arg par_file_names: A list of file names of visualization files to + include in the distributed-memory manifest. .. versionchanged:: 2020.2 diff --git a/meshmode/mesh/__init__.py b/meshmode/mesh/__init__.py index 164759f7..c5ef4d17 100644 --- a/meshmode/mesh/__init__.py +++ b/meshmode/mesh/__init__.py @@ -34,12 +34,8 @@ from pytools import Record, memoize_method __doc__ = """ .. autoclass:: MeshElementGroup - :members: - :undoc-members: .. autoclass:: Mesh - :members: - :undoc-members: .. autoclass:: NodalAdjacency .. autoclass:: FacialAdjacencyGroup -- GitLab