gh-167: try minor docs gen fixes

SparseLinearAlgebra · Aug 29, 2023 · 583d61b · 583d61b
1 parent 24f44dd
commit 583d61b
Show file tree

Hide file tree

Showing 7 changed files with 8 additions and 37 deletions.
diff --git a/.github/workflows/docs-python.yml b/.github/workflows/docs-python.yml
@@ -24,10 +24,10 @@ jobs:
           python-version: ${{ matrix.python-version }}
 
       - name: Install packages
-        run: python -m pip install pdoc3
+        run: python -m pip install pdoc
 
       - name: Build docs
-        run: pdoc -o pydocs --html python/pyspla
+        run: pdoc -o pydocs python/pyspla
         env:
           SPLA_DOCS: true
 

diff --git a/python/pyspla/array.py b/python/pyspla/array.py
@@ -39,13 +39,6 @@ class Array(Object):
     """
     Generalized statically-typed dense linear array primitive.
 
-    Attributes
-    ----------
-
-    - dtype  : `Type` type of stored array elements
-    - n_vals : `int` number of values in the array
-    - shape  : `2-tuple` shape of the array in form of two integers tuple (second dim is 1)
-
     Notes
     -----
 

diff --git a/python/pyspla/memview.py b/python/pyspla/memview.py
@@ -36,13 +36,6 @@ class MemView(Object):
     """
     Wrapper for a memory view object from a library.
 
-    Attributes
-    ----------
-
-    - buffer : `ctypes.c_void_p` hnd to native raw memory buffer
-    - size : `int` size of the buffer in bytes
-    - is_mutable : `bool` whenever buffer content can be modified
-
     Details
     -------
 

diff --git a/python/pyspla/object.py b/python/pyspla/object.py
@@ -35,12 +35,6 @@ class Object:
     """
     Base class for any spla library object.
 
-    Attributes
-    ----------
-
-    - label : `str` user provided text label for object for debugging
-    - hnd : `ctypes.c_void_p` hnd to native object in spla C API
-
     Details
     -------
 

diff --git a/python/pyspla/scalar.py b/python/pyspla/scalar.py
@@ -37,12 +37,6 @@ class Scalar(Object):
     """
     Generalized statically-typed scalar primitive.
 
-    Attributes
-    ----------
-
-    - dtype : `type` type of stored matrix elements
-    - shape : `2-tuple` shape of the scalar in form of two integers tuple (always 1x1)
-
     Notes
     -----
 

diff --git a/python/pyspla/type.py b/python/pyspla/type.py
@@ -45,8 +45,8 @@ class Type:
     """
     Spla base Type for storage parametrization.
 
-    Attributes
-    ----------
+    Binary operations
+    -----------------
 
     PLUS: OpBinary.
         Built-in binary operation associated with a Type.
@@ -87,6 +87,9 @@ class Type:
     BXOR: OpBinary.
         Built-in binary operation associated with a Type. Supported only for integral types.
 
+    Select operations
+    -----------------
+
     EQZERO: OpSelect.
         Built-in selection operation associated with a Type.
 
@@ -151,7 +154,7 @@ class Type:
     @classmethod
     def get_code(cls):
         """
-
+        Literal code of the type in numpy style.
         """
         return cls._code
 

diff --git a/python/pyspla/vector.py b/python/pyspla/vector.py
@@ -33,12 +33,6 @@ class Vector:
     """
     Generalized statically-typed sparse storage-invariant vector primitive.
 
-    Attributes
-    ----------
-
-    - type : `type` type of stored vector elements
-    - shape : `2-tuple` shape of the vector in form of two integers tuple (second dim is 1)
-
     Notes
     -----