Add barebones boundary ref page

Author: felixblanke

docs/ref/boundary.rst

@@ -0,0 +1,30 @@
+.. _ref-modes:
+
+.. currentmodule:: ptwt.constants
+
+Boundary handling modes
+=======================
+
+As is typical the algorithms in this toolbox are designed to be applied to signals of finite size.
+
+.. TODO: Add explanation page on signal extension / boundary wavelets
+
+
+Signal extension via padding
+----------------------------
+
+.. _`modes.padding`:
+
+.. autodata:: BoundaryMode
+
+
+Boundary wavelets
+-----------------
+
+.. _`modes.boundary wavelets`:
+
+.. autodata:: ExtendedBoundaryMode
+
+.. autodata:: PaddingMode
+
+.. autodata:: OrthogonalizeMethod

docs/ref/index.rst

@@ -5,6 +5,7 @@ The ptwt package -- API reference
    :maxdepth: 2
 
    return-types
+   boundary
    conv-fwt
    conv-inverse-fwt
    matrix-fwt

src/ptwt/matmul_transform.py

@@ -170,7 +170,7 @@ class MatrixWavedec(BaseMatrixWaveDec):
     sparse transformation matrix and the input signal.
     This transform uses boundary wavelets instead of padding to
     handle the signal boundaries, see the
-    :ref:`boundary wavelet docs <subsec-boundary-wavelet>`.
+    :ref:`boundary wavelet docs <modes.boundary wavelets>`.
 
     Note:
         Constructing the sparse FWT matrix can be expensive.

src/ptwt/matmul_transform_2.py

@@ -233,7 +233,7 @@ class MatrixWavedec2(BaseMatrixWaveDec):
     sparse transformation matrix and the input signal.
     This transform uses boundary wavelets instead of padding to
     handle the signal boundaries, see the
-    :ref:`boundary wavelet docs <subsec-boundary-wavelet>`.
+    :ref:`boundary wavelet docs <modes.boundary wavelets>`.
 
     Note:
         Constructing the sparse FWT matrix is expensive.