doc!: Deprecate LayoutDict

TODO.md

@@ -5,18 +5,17 @@
   - [x] reimplement on top of ContentObject
 
 ## PLAYA 0.2.x
+- [ ] deprecate LayoutDict
+- [ ] add parallel extraction of pages
 - [ ] Fix ToUnicode CMaps for CID fonts (file bug against pdfminer)
 - [ ] `decode_text` is remarkably slow
 - [ ] `render_char` and `render_string` are also quite slow
 - [ ] add something inbetween `chars` and full bbox for TextObject
       (what do you actually need for heuristic or model-based
       extraction? probably just `adv`?)
 - [ ] remove the rest of the meaningless abuses of `cast`
-- [ ] document how to transform bbox attributes on StructElement,
-      Destination, etc (but you should just use "default" space)
-- [ ] deprecate LayoutDict
 
-## PLAYA 0.3 and beyond
+## PLAYA 1.0
 - [ ] make the structure tree lazy
 - [ ] support ExtGState (submit PR to pdfminer)
 - [ ] better API for document outline, destinations, links, etc

playa/page.py

@@ -478,6 +478,11 @@ class GraphicState:
 class LayoutDict(TypedDict, total=False):
     """Dictionary-based layout objects.
 
+    !!! danger Deprecated
+        This interface is deprecated and has been moved to
+        [PAVÉS](https://github.com/dhdaines/paves).  It will be
+        removed in PLAYA 0.3.
+
     These are somewhat like the `T_obj` dictionaries returned by
     pdfplumber.  The type of coordinates returned are determined by
     the `space` argument passed to `Page`.  By default, `(0, 0)` is
@@ -555,6 +560,7 @@ class LayoutDict(TypedDict, total=False):
         `None` if irrelevant/forbidden,
       srcsize: Source dimensions of image in pixels.
       bits: Number of bits per channel of image.
+
     """
 
     object_type: str
@@ -1208,6 +1214,11 @@ def begin_tag(self, tag: PDFObject, props: Dict[str, PDFObject]) -> None:
 class PageInterpreter(BaseInterpreter):
     """Processor for the content of a PDF page
 
+    !!! danger Deprecated
+        This interface is deprecated and has been moved to
+        [PAVÉS](https://github.com/dhdaines/paves).  It will be
+        removed in PLAYA 0.3.
+
     Reference: PDF Reference, Appendix A, Operator Summary
     """