seedbank doc tweaks

lenskit · May 23, 2024 · 9cd55a5 · 9cd55a5
1 parent f63837a
commit 9cd55a5
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 4 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -23,8 +23,7 @@ Seed Material
 SeedBank seeds (either root seeds or keys for derived RNGs) can be specified in a number
 of formats.
 
-.. py:attribute:: SeedLike
-    :canonical: _keys.SeedLike
+.. py:data:: SeedLike
 
     “Seed-like” data is data that can be used as seed material. This includes:
 
@@ -34,7 +33,7 @@ of formats.
     - :py:class:`bytes` (hashed)
     - :py:class:`numpy.ndarray` (converted to uint32)
 
-.. py:attribute:: RNGKey
+.. py:data:: RNGKey
     :canonical: _keys.RNGKey
 
     ``RNGKey`` is the type of seed-like data (:py:attr:`SeedLike`) *except* for

diff --git a/docs/conf.py b/docs/conf.py
@@ -36,4 +36,4 @@
 
 autodoc_default_options = {"members": True, "member-order": "bysource"}
 autodoc_typehints = "description"
-autodoc_type_aliases = {"SeedLike": "seedbank.SeedLike"}
+# autodoc_type_aliases = {"SeedLike": "seedbank.SeedLike"}