From e9f5e5ba053b4f285f7629529809d0ee696b3ede Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner <inform@tiker.net> Date: Mon, 5 Aug 2024 10:52:00 -0500 Subject: [PATCH] Separate doc page for actx abstraction from doc page for implementations --- doc/array_context.rst | 40 ---------------------------------------- doc/implementations.rst | 40 ++++++++++++++++++++++++++++++++++++++++ doc/index.rst | 1 + 3 files changed, 41 insertions(+), 40 deletions(-) create mode 100644 doc/implementations.rst diff --git a/doc/array_context.rst b/doc/array_context.rst index 85a6cc4..db1182e 100644 --- a/doc/array_context.rst +++ b/doc/array_context.rst @@ -4,43 +4,3 @@ The Array Context Abstraction .. automodule:: arraycontext .. automodule:: arraycontext.context - -Implementations of the Array Context Abstraction -================================================ - -.. - When adding a new array context here, make sure to also add it to and run - ``` - doc/make_numpy_coverage_table.py - ``` - to update the coverage table below! - -Array context based on :mod:`pyopencl.array` --------------------------------------------- - -.. automodule:: arraycontext.impl.pyopencl - - -Lazy/Deferred evaluation array context based on :mod:`pytato` -------------------------------------------------------------- - -.. automodule:: arraycontext.impl.pytato - - -Array context based on :mod:`jax.numpy` ---------------------------------------- - -.. automodule:: arraycontext.impl.jax - -.. _numpy-coverage: - -:mod:`numpy` coverage ---------------------- - -This is a list of functionality implemented by :attr:`arraycontext.ArrayContext.np`. - -.. note:: - - Only functions and methods that have at least one implementation are listed. - -.. include:: numpy_coverage.rst diff --git a/doc/implementations.rst b/doc/implementations.rst new file mode 100644 index 0000000..db35cca --- /dev/null +++ b/doc/implementations.rst @@ -0,0 +1,40 @@ +Implementations of the Array Context Abstraction +================================================ + +.. + When adding a new array context here, make sure to also add it to and run + ``` + doc/make_numpy_coverage_table.py + ``` + to update the coverage table below! + +Array context based on :mod:`pyopencl.array` +-------------------------------------------- + +.. automodule:: arraycontext.impl.pyopencl + + +Lazy/Deferred evaluation array context based on :mod:`pytato` +------------------------------------------------------------- + +.. automodule:: arraycontext.impl.pytato + + +Array context based on :mod:`jax.numpy` +--------------------------------------- + +.. automodule:: arraycontext.impl.jax + +.. _numpy-coverage: + +:mod:`numpy` coverage +--------------------- + +This is a list of functionality implemented by :attr:`arraycontext.ArrayContext.np`. + +.. note:: + + Only functions and methods that have at least one implementation are listed. + +.. include:: numpy_coverage.rst + diff --git a/doc/index.rst b/doc/index.rst index 48fd25b..d3f9854 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -53,6 +53,7 @@ Contents .. toctree:: array_context + implementations container other misc -- GitLab