Merge pull request #679 from waltsims/fix-docs-furo-toc

Fix docs furo toc

Author: waltsims

docs/get_started/first_simulation.rst

@@ -158,7 +158,7 @@ Now we combine all four components and run:
    ``kspaceFirstOrder2D`` / ``3D`` functions. See :doc:`/get_started/new_api`
    for details.
 
-   The legacy functions still work but emit deprecation warnings.
+   The legacy functions still work but emit warnings.
 
 Step 6: Visualize Results
 -------------------------

docs/get_started/new_api.rst

@@ -6,10 +6,6 @@ simulations.  It replaces the legacy ``kspaceFirstOrder2D``,
 ``kspaceFirstOrder3D``, and their GPU variants with a single function that
 auto-detects dimensionality from the grid.
 
-.. contents:: On this page
-   :local:
-   :depth: 2
-
 Quick Start
 -----------
 
@@ -138,4 +134,4 @@ arguments:
    result = kspaceFirstOrder(kgrid, medium, source, sensor, **kwargs)
 
 The legacy ``kspaceFirstOrder2D`` and ``kspaceFirstOrder3D`` functions
-continue to work but emit ``DeprecationWarning``.
+continue to work but emit ``FutureWarning``.

kwave/kspaceFirstOrder2D.py

@@ -205,7 +205,7 @@ def kspaceFirstOrder2D(
         "kspaceFirstOrder2D is deprecated. Use kspaceFirstOrder() from "
         "kwave.kspaceFirstOrder instead. See kwave.compat.options_to_kwargs() "
         "for migrating options.",
-        DeprecationWarning,
+        FutureWarning,
         stacklevel=2,
     )
 

kwave/kspaceFirstOrder3D.py

@@ -198,7 +198,7 @@ def kspaceFirstOrder3D(
         "kspaceFirstOrder3D is deprecated. Use kspaceFirstOrder() from "
         "kwave.kspaceFirstOrder instead. See kwave.compat.options_to_kwargs() "
         "for migrating options.",
-        DeprecationWarning,
+        FutureWarning,
         stacklevel=2,
     )