update docs

inducer · Dec 3, 2024 · 256dbdb · 256dbdb
1 parent fd95813
commit 256dbdb
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 6 deletions.
diff --git a/README.rst b/README.rst
@@ -16,6 +16,7 @@ code to work with all of them? No problem! Comes with pre-made array context
 implementations for:
 
 - numpy
+- cupy
 - `PyOpenCL <https://documen.tician.de/pyopencl/array.html>`__
 - `JAX <https://jax.readthedocs.io/en/latest/>`__
 - `Pytato <https://documen.tician.de/pytato>`__ (for lazy/deferred evaluation)

diff --git a/arraycontext/impl/cupy/__init__.py b/arraycontext/impl/cupy/__init__.py
@@ -1,14 +1,14 @@
-from __future__ import annotations
-
-
 """
 .. currentmodule:: arraycontext
 
-A mod :`cupy`-based array context.
+A :mod:`cupy`-based array context.
 
 .. autoclass:: CupyArrayContext
 """
 
+from __future__ import annotations
+
+
 __copyright__ = """
 Copyright (C) 2024 University of Illinois Board of Trustees
 """

diff --git a/doc/Makefile b/doc/Makefile
@@ -3,7 +3,7 @@
 
 # You can set these variables from the command line, and also
 # from the environment for the first two.
-SPHINXOPTS    ?=
+SPHINXOPTS    ?= -W -n
 SPHINXBUILD   ?= python $(shell which sphinx-build)
 SOURCEDIR     = .
 BUILDDIR      = _build

diff --git a/doc/conf.py b/doc/conf.py
@@ -23,6 +23,7 @@
     "pytest": ("https://docs.pytest.org/en/latest/", None),
     "python": ("https://docs.python.org/3/", None),
     "pytools": ("https://documen.tician.de/pytools", None),
+    "cupy": ("https://docs.cupy.dev/en/stable/", None),
 }
 
 # Some modules need to import things just so that sphinx can resolve symbols in

diff --git a/doc/implementations.rst b/doc/implementations.rst
@@ -13,6 +13,12 @@ Array context based on :mod:`numpy`
 
 .. automodule:: arraycontext.impl.numpy
 
+
+Array context based on :mod:`cupy`
+--------------------------------------------
+
+.. automodule:: arraycontext.impl.cupy
+
 Array context based on :mod:`pyopencl.array`
 --------------------------------------------
 

diff --git a/doc/index.rst b/doc/index.rst
@@ -6,14 +6,15 @@ code to work with all of them? No problem! Comes with pre-made array context
 implementations for:
 
 - :mod:`numpy`
+- :mod:`cupy`
 - :mod:`pyopencl`
 - :mod:`jax.numpy`
 - :mod:`pytato` (for lazy/deferred evaluation)
 - Debugging
 - Profiling
 
 :mod:`arraycontext` started life as an array abstraction for use with the
-:mod:`meshmode` unstrucuted discretization package.
+:mod:`meshmode` unstructured discretization package.
 
 Design Guidelines
 -----------------