📝 update docs

Author: ianardee

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Mindee Python API Library Changelog
 
-## v3.0.0 (2022-10-31)
+## v3.0.0 (2022-11-07)
 ### ¡Breaking Changes!
 * :sparkles: New PDF cut/merge system, allowing specifying exactly which pages to use.
 * :recycle: PDF documents are no longer cut by default, use the `page_options` parameter in the `parse` method.

README.md

@@ -23,7 +23,7 @@ mindee_client = Client(api_key="my-api-key")
 
 # Load a file from disk
 input_doc = mindee_client.doc_from_path("/path/to/the/invoice.pdf")
-# Parse the document as an invoice by passing the documents.Invoice type
+# Parse the document as an invoice by passing the appropriate type
 api_response = input_doc.parse(documents.TypeInvoiceV3)
 
 # Print a brief summary of the parsed data
@@ -39,7 +39,7 @@ mindee_client = Client(api_key="my-api-key")
 
 # Load a file from disk
 input_doc = mindee_client.doc_from_path("/path/to/the/check.jpg")
-# Parse the document as a USA bank check by passing the documents.us.TypeBankCheckV1 type
+# Parse the document as a USA bank check by passing the appropriate type
 api_response = input_doc.parse(documents.us.TypeBankCheckV1)
 
 # Print a brief summary of the parsed data
@@ -72,7 +72,10 @@ There's more to it than that for those that need more features, or want to
 customize the experience.
 
 All the juicy details are described in the
-**[Official Documentation](https://developers.mindee.com/docs/python-sdk)**.
+**[Official Guide](https://developers.mindee.com/docs/python-sdk)**.
+
+You can also take a look at the
+**[Reference Documentation](https://mindee.github.io/mindee-api-python/)**.
 
 ## License
 Copyright © Mindee

docs/client.rst

@@ -11,10 +11,13 @@ Client
 
 DocumentClient
 --------------
+.. autoclass:: mindee.input.page_options.PageOptions
+    :members:
+
 .. autoclass:: mindee.client.DocumentClient
     :members:
 
-DocumentResponse
-----------------
-.. autoclass:: mindee.response.DocumentResponse
+PredictResponse
+---------------
+.. autoclass:: mindee.response.PredictResponse
     :members:

docs/conf.py

@@ -29,6 +29,7 @@
 # ones.
 extensions = [
     "sphinx.ext.autodoc",
+    "sphinx_autodoc_typehints",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -56,4 +57,13 @@
 html_static_path = ["_static"]
 
 
+# -- autodoc -----------------------------------------------------------------
+
 autodoc_member_order = "groupwise"
+autodoc_class_signature = "separated"
+autodoc_typehints = "description"
+autodoc_default_options = {"undoc-members": True, "exclude-members": "__init__"}
+
+# -- autodoc-typehints -------------------------------------------------------
+
+typehints_defaults = "comma"

docs/documents.rst

@@ -0,0 +1,7 @@
+----------------
+Geometry Helpers
+----------------
+
+.. automodule:: mindee.geometry
+    :members:
+    :undoc-members:

docs/field_types.rst

@@ -14,5 +14,5 @@ https://developers.mindee.com/docs/python-sdk
    :caption: Contents:
 
    client
-   field_types
-   documents
+   products/index
+   geometry

docs/geometry.rst

@@ -0,0 +1,4 @@
+Custom Documents
+================
+.. autoclass:: mindee.documents.CustomV1
+    :members:

docs/index.rst

@@ -0,0 +1,87 @@
+------
+Fields
+------
+
+Off the Shelf Documents
+=======================
+
+Base Field
+----------
+.. autoclass:: mindee.fields.base.BaseField
+    :members:
+    :inherited-members:
+
+Text Field
+----------
+.. autoclass:: mindee.fields.text.TextField
+    :members:
+    :inherited-members:
+
+Typed Field
+-----------
+.. autoclass:: mindee.fields.typed.TypedField
+    :members:
+    :inherited-members:
+
+Amount Field
+------------
+.. autoclass:: mindee.fields.amount.AmountField
+    :members:
+    :inherited-members:
+
+Date Field
+----------
+.. autoclass:: mindee.fields.date.DateField
+    :members:
+    :inherited-members:
+
+Tax Field
+---------
+.. autoclass:: mindee.fields.tax.TaxField
+    :members:
+    :inherited-members:
+
+Locale Field
+------------
+.. autoclass:: mindee.fields.locale.LocaleField
+    :members:
+    :inherited-members:
+
+Orientation
+-----------
+.. autoclass:: mindee.fields.orientation.Orientation
+    :members:
+    :inherited-members:
+
+Payment Details
+---------------
+.. autoclass:: mindee.fields.payment_details.PaymentDetails
+    :members:
+    :inherited-members:
+
+Position
+--------
+.. autoclass:: mindee.fields.position.Position
+    :members:
+    :inherited-members:
+
+Custom Documents
+================
+
+Value List
+----------
+.. autoclass:: mindee.fields.api_builder.ListField
+    :members:
+    :inherited-members:
+
+Word Value
+----------
+.. autoclass:: mindee.fields.api_builder.ListFieldValue
+    :members:
+    :inherited-members:
+
+Classification
+--------------
+.. autoclass:: mindee.fields.api_builder.ClassificationField
+    :members:
+    :inherited-members: