added configurations to provide links to and documentation of documented class methods and attributes, changed member order to groupwise from its default alphabetical to ensure class methods appear grouped together in the documentation html ahead of attributes which alspo appear grouped together, added docstrings for public attributes of PersistenceImager

Author: Francis Motta

docs/conf.py

@@ -21,3 +21,9 @@
 
 html_short_title = project
 htmlhelp_basename = 'Persimdoc'
+
+autodoc_default_options = {
+    'members': True
+}
+
+autodoc_member_order = 'groupwise'

docs/reference/index.rst

@@ -21,6 +21,7 @@ Persistence Images
 
 .. autosummary::
     :toctree: stubs
+    :recursive:
     :nosignatures:
 
     persim.PersistenceImager

persim/images.py

@@ -329,18 +329,50 @@ def __init__(self, birth_range=None, pers_range=None, pixel_size=None, weight=No
 
     @property
     def width(self):
+        """
+        Persistence image width.
+        
+        Returns
+        -------
+        width : float
+            The width of the region of the birth-persistence plane covered by the persistence image in birth units.
+        """
         return self._width
 
     @property
     def height(self):
+        """
+        Persistence image height.
+        
+        Returns
+        -------
+        height : float
+            The height of the region of the birth-persistence plane covered by the persistence image in persistence units.
+        """
         return self._height
 
     @property
     def resolution(self):
+        """
+        Persistence image resolution.
+        
+        Returns
+        -------
+        resolution : pair of ints (width, height)
+            The number of pixels along each dimension of the persistence image, determined by the birth and persistence ranges and the pixel size.
+        """
         return self._resolution
 
     @property
     def pixel_size(self):
+        """
+        Persistence image square pixel dimensions.
+        
+        Returns
+        -------
+        pixel_size : float
+            The width (and height) in birth/persistence units of each square pixel in the persistence image. 
+        """
         return self._pixel_size
 
     @pixel_size.setter
@@ -353,6 +385,14 @@ def pixel_size(self, val):
 
     @property
     def birth_range(self):
+        """
+        Range of birth values covered by the persistence image.
+        
+        Returns
+        -------
+        birth_range : pair of floats (min. birth, max. birth)
+            The minimum and maximum birth values covered by the persistence image.
+        """
         return self._birth_range
 
     @birth_range.setter
@@ -364,6 +404,14 @@ def birth_range(self, val):
 
     @property
     def pers_range(self):
+        """
+        Range of persistence values covered by the persistence image.
+        
+        Returns
+        -------
+        pers_range : pair of floats (min. persistence, max. persistence)
+            The minimum and maximum persistence values covered by the persistence image.
+        """
         return self._pers_range
 
     @pers_range.setter