Add miscellaneous documentation for exceptions and finder module

Toblerity · Jan 19, 2024 · e67224a · e67224a
1 parent 40fc060
commit e67224a
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 4 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -25,6 +25,7 @@ Documentation
    install
    tutorial
    class
+   misc
    changes
    performance
    history

diff --git a/docs/source/misc.rst b/docs/source/misc.rst
@@ -0,0 +1,16 @@
+.. _misc:
+
+Miscellaneous Documentation
+------------------------------------------------------------------------------
+
+Exceptions
+==========
+
+.. autoexception:: rtree.exceptions.RTreeError
+    :members:
+
+Finder module
+=============
+
+.. automodule:: rtree.finder
+    :members:
diff --git a/rtree/finder.py b/rtree/finder.py
@@ -1,8 +1,5 @@
 """
-finder.py
-------------
-
-Locate `libspatialindex` shared library by any means necessary.
+Locate `libspatialindex` shared library and header files.
 """
 from __future__ import annotations
-Original file line number
+Diff line change
@@ Expand Up / @@ -25,6 +25,7 @@ Documentation @@
        install
        tutorial
        class
+       misc
        changes
        performance
        history
@@ Expand Down @@