diff --git a/arraycontext/__init__.py b/arraycontext/__init__.py index 1d13741ce1815d9a901467953a526f7b8e55d9de..37d8fc801ba8845cdf6ad512a75e825cf4c29952 100644 --- a/arraycontext/__init__.py +++ b/arraycontext/__init__.py @@ -1,3 +1,9 @@ +""" +An array context is an abstraction that helps you dispatch between multiple +implementations of :mod:`numpy`-like :math:`n`-dimensional arrays. +""" + + __copyright__ = """ Copyright (C) 2020-1 University of Illinois Board of Trustees """ diff --git a/doc/array_context.rst b/doc/array_context.rst new file mode 100644 index 0000000000000000000000000000000000000000..95c7a5e52fbad92579675c345968d89ec0fc2b33 --- /dev/null +++ b/doc/array_context.rst @@ -0,0 +1,7 @@ +The Array Context Abstraction +============================= + +.. automodule:: arraycontext + +Implementations of the Array Context Abstraction +================================================ diff --git a/doc/index.rst b/doc/index.rst index 58db970c9ce2c5bc69e40043065e4badccf17a1c..9d0e0b14c5a72de35170a1fcb2588cf23e9fea91 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -5,9 +5,10 @@ Welcome to arraycontext's documentation! :maxdepth: 2 :caption: Contents: + array_context misc - 🚀 Github - 💾 Download Releases + 🚀 Github + 💾 Download Releases Indices and tables ==================