pydantic_modelsのドキュメントを生成

.vscode/cspell.json

@@ -30,6 +30,7 @@
         "kurusugawa",
         "ndarray",
         "netrc",
+        "pydantic",
         "pydata",
         "pylint",
         "relativedelta",

annofabapi/parser.py

@@ -1,4 +1,4 @@
-import abc
+import abc  # noqa: A005
 import json
 import os
 import zipfile

annofabapi/pydantic_models/annotation_detail_content_output_inner_unknown.py

@@ -23,7 +23,7 @@
 class AnnotationDetailContentOutputInnerUnknown(BaseModel):
     """
     アノテーションのデータ部をJSON内部に保持します。 AnnotationDetailV1の形式で保存されていたデータのAnnotationTypeが特定できない場合にこの値となります。 典型的な例では、アノテーションの保存後にアノテーション仕様が書き換わっていた場合が該当します。
-    """  # noqa: E501
+    """
 
     type: StrictStr = Field(alias="_type")
     data: StrictStr = Field(

annofabapi/pydantic_models/annotation_detail_content_output_outer_unresolved.py

@@ -23,7 +23,7 @@
 class AnnotationDetailContentOutputOuterUnresolved(BaseModel):
     """
     アノテーションのデータ部を外部ファイルの形式（画像など）で保持します。 Outerのurl / etagを解決しなかった場合（過去のアノテーションを取得した場合等）にこの値となります。
-    """  # noqa: E501
+    """
 
     type: StrictStr = Field(alias="_type")
     __properties: ClassVar[List[str]] = ["_type"]

annofabapi/pydantic_models/annotation_props_for_editor.py

@@ -23,7 +23,7 @@
 class AnnotationPropsForEditor(BaseModel):
     """
     アノテーションエディタ用のアノテーション毎のプロパティです。<br /> ここに含まれているデータはアノテーション結果に反映されず、エディタが利用するために存在します。  エディタ用のデータであるため、たとえば`can_delete`や`can_edit_data`が`false`でも、APIによる編集は妨げません。<br /> ここで定義されているデータを利用して動作を変えるかどうかは、エディタによって異なります。
-    """  # noqa: E501
+    """
 
     can_delete: Optional[StrictBool] = Field(default=None, description="アノテーションがエディタ上で削除できるかどうか。 trueの場合削除可能。")
     can_edit_data: Optional[StrictBool] = Field(

annofabapi/pydantic_models/plugin_detail_extended_annotation_specs.py

@@ -28,7 +28,7 @@
 class PluginDetailExtendedAnnotationSpecs(BaseModel):
     """
     カスタムのアノテーション種別を作成するプラグインを表します。 なお、このプラグインが設定されているプロジェクトでは、ここで指定したアノテーション種別以外は使用できなくなります。
-    """  # noqa: E501
+    """
 
     plugin_compatibility: Optional[OrganizationPluginCompatibility] = None
     annotation_types: List[AnnotationType] = Field(

annofabapi/pydantic_models/position_for_minimum_bounding_box_insertion.py

@@ -23,7 +23,7 @@
 class PositionForMinimumBoundingBoxInsertion(BaseModel):
     """
     `annotation_type` が `bounding_box` かつ `min_warn_rule` が `and` または `or` の場合のみ、挿入する最小矩形アノテーションの原点を指定できます。 画像左上の座標が「x=0, y=0」です。 未指定、もしくは「画像外に飛び出たアノテーション」を許可していないにも関わらず飛び出してしまう場合は、表示範囲の中央に挿入されます。 「スキャンした帳票の記入欄」や「定点カメラで撮影した製品ラベル」など、アノテーションしたい位置やサイズが多くの画像で共通している場合に便利です。  `annotation_type` が `bounding_box` 以外の場合は必ず未指定となります。
-    """  # noqa: E501
+    """
 
     x: StrictInt
     y: StrictInt

annofabapi/pydantic_models/task_generate_rule_by_input_data_csv.py

@@ -23,7 +23,7 @@
 class TaskGenerateRuleByInputDataCsv(BaseModel):
     """
     各タスクへの入力データへの割当を記入したCSVへのS3上のパスを指定してタスクを生成します。 1つのタスクに対する入力データの個数は最大200です。200を超えるタスクが1つでもある場合にはタスク生成に失敗します。
-    """  # noqa: E501
+    """
 
     csv_data_path: StrictStr = Field(description="各タスクへの入力データへの割り当てを記入したCSVへのS3上のパス。 ")
     type: Optional[StrictStr] = Field(

annofabapi/resource.py

@@ -1,4 +1,4 @@
-import logging
+import logging  # noqa: A005
 import netrc
 import os
 from typing import Optional, Union

docs/api_reference/credentials.rst

@@ -0,0 +1,6 @@
+annofabapi.credentials module
+============================
+
+.. automodule:: annofabapi.credentials
+    :members:
+

docs/api_reference/index.rst

@@ -14,5 +14,7 @@ API reference
    dataclass
    exceptions
    segmentation
+   pydantic_models
    models
+