📝 each api doc should be in its own file

ianardee · ianardee · commit 47ab4e43b4dd · 2023-02-17T12:16:32.000+01:00
diff --git a/docs/predictions/standard/documents/financial_document_v1.rst b/docs/predictions/standard/documents/financial_document_v1.rst
@@ -0,0 +1,4 @@
+Financial Document V1
+---------------------
+.. autoclass:: mindee.documents.FinancialDocumentV1
+    :members:
diff --git a/docs/predictions/standard/documents/fr/carte_grise_v1.rst b/docs/predictions/standard/documents/fr/carte_grise_v1.rst
@@ -0,0 +1,6 @@
+Carte Grise V1
+--------------
+
+.. autoclass:: mindee.documents.fr.CarteGriseV1
+    :members:
+    :undoc-members:
diff --git a/docs/predictions/standard/documents/fr/carte_vitale_v1.rst b/docs/predictions/standard/documents/fr/carte_vitale_v1.rst
@@ -0,0 +1,11 @@
+Carte Vitale V1
+---------------
+
+**Sample Code:**
+
+.. literalinclude:: /code_samples/fr/carte_vitale_v1.py
+    :language: Python
+
+.. autoclass:: mindee.documents.fr.CarteVitaleV1
+    :members:
+    :undoc-members:
diff --git a/docs/predictions/standard/documents/fr/id_card_v1.rst b/docs/predictions/standard/documents/fr/id_card_v1.rst
@@ -0,0 +1,11 @@
+Carte Nationale d'Identité V1
+-----------------------------
+
+**Sample Code:**
+
+.. literalinclude:: /code_samples/fr/id_card_v1.py
+    :language: Python
+
+.. autoclass:: mindee.documents.fr.IdCardV1
+    :members:
+    :undoc-members:
diff --git a/docs/predictions/standard/documents/invoice_v3.rst b/docs/predictions/standard/documents/invoice_v3.rst
@@ -0,0 +1,4 @@
+Invoice V3
+----------
+.. autoclass:: mindee.documents.InvoiceV3
+    :members:
diff --git a/docs/predictions/standard/documents/invoice_v4.rst b/docs/predictions/standard/documents/invoice_v4.rst
@@ -0,0 +1,4 @@
+Invoice V4
+----------
+.. autoclass:: mindee.documents.InvoiceV4
+    :members:
diff --git a/docs/predictions/standard/documents/passport_v1.rst b/docs/predictions/standard/documents/passport_v1.rst
@@ -0,0 +1,4 @@
+Passport V1
+-----------
+.. autoclass:: mindee.documents.PassportV1
+    :members:
diff --git a/docs/predictions/standard/documents/receipt_v3.rst b/docs/predictions/standard/documents/receipt_v3.rst
@@ -0,0 +1,4 @@
+Receipt V3
+----------
+.. autoclass:: mindee.documents.ReceiptV3
+    :members:
diff --git a/docs/predictions/standard/documents/receipt_v4.rst b/docs/predictions/standard/documents/receipt_v4.rst
@@ -0,0 +1,4 @@
+Receipt V4
+----------
+.. autoclass:: mindee.documents.ReceiptV4
+    :members:
diff --git a/docs/predictions/standard/documents/us/bank_check_v1.rst b/docs/predictions/standard/documents/us/bank_check_v1.rst
@@ -0,0 +1,6 @@
+Bank Check V1
+-------------
+
+.. autoclass:: mindee.documents.us.BankCheckV1
+    :members:
+    :undoc-members:
diff --git a/docs/predictions/standard/fr.rst b/docs/predictions/standard/fr.rst
@@ -1,8 +1,6 @@
 France
 ======
 
-Carte Grise
------------
-.. autoclass:: mindee.documents.fr.CarteGriseV1
-    :members:
-    :undoc-members:
+.. include:: ./documents/fr/id_card_v1.rst
+.. include:: ./documents/fr/carte_vitale_v1.rst
+.. include:: ./documents/fr/carte_grise_v1.rst
diff --git a/docs/predictions/standard/fr/carte_vitale_v1.rst b/docs/predictions/standard/fr/carte_vitale_v1.rst
@@ -0,0 +1,11 @@
+Carte Vitale V1
+---------------
+
+**Sample Code:**
+
+.. literalinclude:: /code_samples/fr/carte_vitale_v1.py
+    :language: Python
+
+.. autoclass:: mindee.documents.fr.CarteVitaleV1
+    :members:
+    :undoc-members:
diff --git a/docs/predictions/standard/fr/id_card_v1.rst b/docs/predictions/standard/fr/id_card_v1.rst
@@ -0,0 +1,11 @@
+Carte Nationale d'Identité V1
+-----------------------------
+
+**Sample Code:**
+
+.. literalinclude:: /code_samples/fr/id_card_v1.py
+    :language: Python
+
+.. autoclass:: mindee.documents.fr.IdCardV1
+    :members:
+    :undoc-members:
diff --git a/docs/predictions/standard/index.rst b/docs/predictions/standard/index.rst
@@ -2,9 +2,9 @@ Off the Shelf
 #############
 
 .. toctree::
-   :maxdepth: 2
+    :maxdepth: 2
 
-   ./international
-   ./us
-   ./fr
-   ./field_types
+    ./field_types
+    ./international
+    ./us
+    ./fr
diff --git a/docs/predictions/standard/international.rst b/docs/predictions/standard/international.rst
@@ -1,30 +1,9 @@
 International
 =============
 
-Invoices
---------
-.. autoclass:: mindee.documents.InvoiceV3
-    :members:
-
-.. autoclass:: mindee.documents.InvoiceV4
-    :members:
-
-Expense Receipts
-----------------
-.. autoclass:: mindee.documents.ReceiptV3
-    :members:
-
-.. autoclass:: mindee.documents.ReceiptV4
-    :members:
-
-Passports
----------
-.. autoclass:: mindee.documents.PassportV1
-    :members:
-
-Financial Documents
--------------------
-.. autoclass:: mindee.documents.FinancialV1
-    :members:
-    :undoc-members:
-    :exclude-members: __init__, request
+.. include:: ./documents/financial_document_v1.rst
+.. include:: ./documents/passport_v1.rst
+.. include:: ./documents/invoice_v3.rst
+.. include:: ./documents/invoice_v4.rst
+.. include:: ./documents/receipt_v3.rst
+.. include:: ./documents/receipt_v4.rst
diff --git a/docs/predictions/standard/us.rst b/docs/predictions/standard/us.rst
@@ -1,8 +1,4 @@
 United States of America
-========================
+########################
 
-Bank Checks
------------
-.. autoclass:: mindee.documents.us.BankCheckV1
-    :members:
-    :undoc-members:
+.. include:: ./documents/us/bank_check_v1.rst
diff --git a/tests/documents/fr/test_carte_vitale_v1.py b/tests/documents/fr/test_carte_vitale_v1.py
@@ -33,18 +33,12 @@ def carte_vitale_v1_page0():
 
 
 def test_doc_constructor(carte_vitale_v1_doc):
-    reference_str = (
-        open(f"{ FR_CARTE_VITALE_DATA_DIR }/response_v1/doc_to_string.txt")
-        .read()
-        .strip()
-    )
+    file_path = f"{ FR_CARTE_VITALE_DATA_DIR }/response_v1/doc_to_string.txt"
+    reference_str = open(file_path, "r", encoding="utf-8").read().strip()
     assert str(carte_vitale_v1_doc) == reference_str
 
 
 def test_page0_constructor(carte_vitale_v1_page0):
-    reference_str = (
-        open(f"{ FR_CARTE_VITALE_DATA_DIR }/response_v1/page0_to_string.txt")
-        .read()
-        .strip()
-    )
+    file_path = f"{ FR_CARTE_VITALE_DATA_DIR }/response_v1/page0_to_string.txt"
+    reference_str = open(file_path, "r", encoding="utf-8").read().strip()
     assert str(carte_vitale_v1_page0) == reference_str
diff --git a/tests/documents/fr/test_id_card_v1.py b/tests/documents/fr/test_id_card_v1.py
@@ -29,14 +29,12 @@ def id_card_v1_page0():
 
 
 def test_doc_constructor(id_card_v1_doc):
-    reference_str = (
-        open(f"{ FR_ID_CARD_DATA_DIR }/response_v1/doc_to_string.txt").read().strip()
-    )
+    file_path = f"{ FR_ID_CARD_DATA_DIR }/response_v1/doc_to_string.txt"
+    reference_str = open(file_path, "r", encoding="utf-8").read().strip()
     assert str(id_card_v1_doc) == reference_str
 
 
 def test_page0_constructor(id_card_v1_page0):
-    reference_str = (
-        open(f"{ FR_ID_CARD_DATA_DIR }/response_v1/page0_to_string.txt").read().strip()
-    )
+    file_path = f"{ FR_ID_CARD_DATA_DIR }/response_v1/page0_to_string.txt"
+    reference_str = open(file_path, "r", encoding="utf-8").read().strip()
     assert str(id_card_v1_page0) == reference_str
