enh: Refactoring the viz module to a more modular design

Everything is now based on functions that adhere to functional programming. We combine these functions to create workflows and then use the sisl.nodes framework to provide the update functionality. Plotting backends are now implemented each on a single `Figure` class that implements generic drawing methods, as well as subplots, animations... functionality.
zerothi · Sep 28, 2023 · fc9d1b0 · fc9d1b0
1 parent 51736b4
commit fc9d1b0
Show file tree

Hide file tree

Showing 209 changed files with 51,635 additions and 20,514 deletions.
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -25,6 +25,7 @@ All methods and submodules are listed  :ref:`here <genindex>` and
    default_geom
    physics
    mixing
+   viz/index
    unit_constant
    utilities
 
@@ -38,5 +39,4 @@ All methods and submodules are listed  :ref:`here <genindex>` and
    :caption: Advanced usage
 
    nodes
-   viz/index
 
diff --git a/docs/api/viz/index.rst b/docs/api/viz/index.rst
@@ -4,12 +4,37 @@
 Visualization
 =============
 
-.. currentmodule:: sisl.viz
+.. module:: sisl.viz
 
-Visualizations of `sisl` objects and data.
+The visualization module contains tools to plot common visualizations, as well
+as to create custom visualizations that support multiple plotting backends
+automatically.
 
+Plot classes
+-----------------
+
+Plot classes are workflow classes that implement some specific plotting.
+
+.. autosummary::
+    :toctree: generated/
+
+    Plot
+    BandsPlot
+    FatbandsPlot
+    GeometryPlot
+    SitesPlot
+    GridPlot
+    WavefunctionPlot
+    PdosPlot
+
+Utilities
+---------
+
+Utilities to build custom plots
 
 .. autosummary::
-   :toctree: generated/
-   :recursive:
+    :toctree: generated/
 
+    get_figure
+    merge_plots
+    Figure