remove plotting examples and link to gallery instead

pyfar · Apr 20, 2024 · a253798 · a253798
1 parent 0498351
commit a253798
Show file tree

Hide file tree

Showing 8 changed files with 8 additions and 92 deletions.
diff --git a/docs/concepts.rst b/docs/concepts.rst
diff --git a/docs/concepts/pyfar.plot.rst b/docs/concepts/pyfar.plot.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -129,6 +129,6 @@
 
 # write shortcuts to sphinx readable format
 _, shortcuts = pyfar.plot.shortcuts(show=False, report=True, layout="sphinx")
-shortcuts_path = os.path.join("concepts", "resources", "plot_shortcuts.rst")
+shortcuts_path = os.path.join("resources", "plot_shortcuts.rst")
 with open(shortcuts_path, "w") as f_id:
     f_id.writelines(shortcuts)
diff --git a/docs/index.rst b/docs/index.rst
@@ -13,11 +13,6 @@ Getting Started
 Documentation
 =============
 
-.. toctree::
-   :maxdepth: 2
-
-   concepts
-
 .. toctree::
    :maxdepth: 2
 

diff --git a/docs/concepts/resources/plot_shortcuts.rst → docs/resources/plot_shortcuts.rst b/docs/concepts/resources/plot_shortcuts.rst → docs/resources/plot_shortcuts.rst
diff --git a/pyfar/_concepts/plots.py b/pyfar/_concepts/plots.py
diff --git a/pyfar/plot/__init__.py b/pyfar/plot/__init__.py
@@ -1,8 +1,12 @@
 # -*- coding: utf-8 -*-
 
 """
-The following documents the pyfar plot functions. Refer to the
-:py:mod:`concepts <pyfar._concepts.plots>` for more background information.
+The following documents the pyfar plot functions. Make sure to have a look at
+the `plotting <https://pyfar-gallery.readthedocs.io/en/latest/gallery/
+interactive/pyfar_plotting.html>`_  and `interactive plotting
+<https://pyfar-gallery.readthedocs.io/en/latest/gallery/interactive/
+pyfar_interactive_plots.html>`_ examples. The latter make use of the pyfar
+:py:func:`~pyfar.plot.shortcuts` to quickly explore acoustic signals.
 """
 
 from .line import (

diff --git a/pyfar/plot/utils.py b/pyfar/plot/utils.py
@@ -201,7 +201,7 @@ def shortcuts(show=True, report=False, layout="console"):
     `Matplotlib backend
     <https://matplotlib.org/stable/users/explain/backends.html>`_
 
-    .. include:: ../../docs/concepts/resources/plot_shortcuts.rst
+    .. include:: ../../docs/resources/plot_shortcuts.rst
 
     Parameters
     ----------