Skip to content

Commit 22533df

Browse files
committed
docs: Add docstrings to animations submodule, Update and enhance docstrings of gridder and plotting submodules
1 parent 4f321b4 commit 22533df

File tree

5 files changed

+796
-85
lines changed

5 files changed

+796
-85
lines changed
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
2+
.. _plotting_animations:
3+
4+
*************************************************
5+
Animations (:mod:`pyvisgrid.plotting.animations`)
6+
*************************************************
7+
8+
.. currentmodule:: pyvisgrid.plotting.animations
9+
10+
Animations submodule of :mod:`pyvisgrid.plotting`.
11+
12+
13+
Reference/API
14+
=============
15+
16+
.. automodapi:: pyvisgrid.plotting.animations
17+
:inherited-members:

docs/api-reference/plotting/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Plotting (:mod:`pyvisgrid.plotting`)
1010
Introduction
1111
============
1212

13-
:mod:`pyvisgrid.plotting` contains plotting methods for gridded and ungridded data.
13+
:mod:`pyvisgrid.plotting` contains plotting and animation methods for gridded and ungridded data.
1414

1515

1616
Submodules
@@ -21,6 +21,7 @@ Submodules
2121
:glob:
2222

2323
plotting
24+
animations
2425

2526
Reference/API
2627
=============

0 commit comments

Comments
 (0)