From 014ae9b3b293b8297922d2c6adb07aff6a0d5432 Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner Date: Fri, 25 Jan 2019 11:20:23 -0600 Subject: [PATCH] Documentation gardening --- doc/Makefile | 8 ++++---- doc/connection.rst | 4 ++++ doc/discretization.rst | 9 ++------- doc/index.rst | 1 + .../discretization/connection/__init__.py | 20 ++++++++++++++++--- 5 files changed, 28 insertions(+), 14 deletions(-) create mode 100644 doc/connection.rst diff --git a/doc/Makefile b/doc/Makefile index ef3f08b4..16b3dd6c 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -3,14 +3,14 @@ # You can set these variables from the command line. SPHINXOPTS = -SPHINXBUILD = sphinx-build +SPHINXBUILD = python -m sphinx PAPER = BUILDDIR = _build # User-friendly check for sphinx-build -ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) -endif +# ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +# $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +# endif # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 diff --git a/doc/connection.rst b/doc/connection.rst new file mode 100644 index 00000000..7f4660bc --- /dev/null +++ b/doc/connection.rst @@ -0,0 +1,4 @@ +Connections: Interpolating between Discretizations +================================================== + +.. automodule:: meshmode.discretization.connection diff --git a/doc/discretization.rst b/doc/discretization.rst index 5e66d79b..9389cd85 100644 --- a/doc/discretization.rst +++ b/doc/discretization.rst @@ -6,16 +6,11 @@ Abstract interface .. automodule:: meshmode.discretization -Composite polynomial discretization ------------------------------------ +Element Groups for Composite Polynomial Discretization +------------------------------------------------------ .. automodule:: meshmode.discretization.poly_element -Connection/interpolation ------------------------- - -.. automodule:: meshmode.discretization.connection - Visualization ------------- diff --git a/doc/index.rst b/doc/index.rst index 4bde9b27..3a7a2ba7 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -8,6 +8,7 @@ Contents: mesh discretization + connection misc Indices and tables diff --git a/meshmode/discretization/connection/__init__.py b/meshmode/discretization/connection/__init__.py index 5f136982..ee1efd0c 100644 --- a/meshmode/discretization/connection/__init__.py +++ b/meshmode/discretization/connection/__init__.py @@ -61,27 +61,41 @@ __all__ = [ ] __doc__ = """ +Base classes +------------ .. autoclass:: DiscretizationConnection .. autoclass:: ChainedDiscretizationConnection .. autoclass:: DirectDiscretizationConnection + +Same-mesh connections +--------------------- .. autofunction:: make_same_mesh_connection -.. autofunction:: FACE_RESTR_INTERIOR -.. autofunction:: FACE_RESTR_ALL +Restriction to faces +-------------------- +.. autodata:: FACE_RESTR_INTERIOR +.. autodata:: FACE_RESTR_ALL .. autofunction:: make_face_restriction .. autofunction:: make_face_to_all_faces_embedding .. autofunction:: make_opposite_face_connection + +Mesh partitioning +----------------- .. autofunction:: make_partition_connection +Refinement +---------- .. autofunction:: make_refinement_connection +Flattening a :class:`ChainedDiscretizationConnection` +----------------------------------------------------- .. autofunction:: flatten_chained_connection Implementation details -^^^^^^^^^^^^^^^^^^^^^^ +---------------------- .. autoclass:: InterpolationBatch -- GitLab