Merge pull request #613 from lsst/tickets/DM-32820

DM-32820: Skip ButlerURI in table of contents
lsst · Dec 7, 2021 · ebe0530 · ebe0530
2 parents 7439250 + e3fa06e
commit ebe0530
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/doc/changes/DM-31723.api.rst b/doc/changes/DM-31723.api.rst
@@ -0,0 +1,3 @@
+The ``ButlerURI`` class has now been removed from this package.
+It now exists as `lsst.resources.ResourcePath`.
+All code should be modified to use the new class name.
diff --git a/doc/lsst.daf.butler/index.rst b/doc/lsst.daf.butler/index.rst
@@ -100,6 +100,12 @@ Python API reference
 
 .. automodapi:: lsst.daf.butler
    :no-main-docstr:
+   :skip: ButlerURI
+
+.. py:class:: lsst.daf.butler.ButlerURI(uri)
+
+   ``ButlerURI`` implementation. Exists for backwards compatibility.
+   New code should use `lsst.resources.ResourcePath`.
 
 .. automodapi:: lsst.daf.butler.registry
    :no-main-docstr: