docs: use autosummary to generate rst files in opendataset under "API"

PR Closed: #1086
Graviti-AI · Nov 9, 2021 · 764c28f · 764c28f
1 parent c57ea4b
commit 764c28f
Show file tree

Hide file tree

Showing 49 changed files with 76 additions and 280 deletions.
diff --git a/docs/source/reference/api/index.rst b/docs/source/reference/api/index.rst
@@ -11,4 +11,4 @@ API Reference
    sensor/index
    utility/index
    exception
-   opendataset/index
+   opendataset
diff --git a/docs/source/reference/api/opendataset.rst b/docs/source/reference/api/opendataset.rst
@@ -0,0 +1,74 @@
+=====================
+tensorbay.opendataset
+=====================
+
+.. currentmodule:: tensorbay.opendataset
+
+.. autosummary::
+   :nosignatures:
+   :toctree: api_rst/
+
+   AADB
+   AnimalPose5
+   AnimalPose7
+   AnimalsWithAttributes2
+   BDD100K
+   BDD100K_10K
+   BDD100K_MOT2020
+   BDD100K_MOTS2020
+   BSTLD
+   BioIDFace
+   CACD
+   CADC
+   CarConnection
+   CCPD
+   CCPDGreen
+   CIHP
+   COCO2017
+   COVIDChestXRay
+   COVID_CT
+   CoinImage
+   CompCars
+   DAVIS2017SemiSupervised
+   DAVIS2017Unsupervised
+   DeepRoute
+   DogsVsCats
+   DownsampledImagenet
+   Elpv
+   FLIC
+   FSDD
+   Flower17
+   Flower102
+   HalpeFullBody
+   HardHatWorkers
+   HeadPoseImage
+   ImageEmotionAbstract
+   ImageEmotionArtphoto
+   JHU_CROWD
+   KenyanFoodOrNonfood
+   KenyanFoodType
+   KylbergTexture
+   LIP
+   LISATrafficLight
+   LISATrafficSign
+   LeedsSportsPose
+   NeolixOD
+   Newsgroups20
+   NightOwls
+   nuImages
+   nuScenes
+   OxfordIIITPet
+   PASCALContext
+   RP2K
+   SCUT_FBP5500
+   SegTrack
+   SegTrack2
+   SVHN
+   THCHS30
+   THUCNews
+   TLR
+   UAVDT
+   VOC2012ActionClassification
+   VOC2012Detection
+   VOC2012Segmentation
+   WIDER_FACE
diff --git a/docs/source/reference/api/opendataset/AADB.rst b/docs/source/reference/api/opendataset/AADB.rst
diff --git a/docs/source/reference/api/opendataset/AnimalPose.rst b/docs/source/reference/api/opendataset/AnimalPose.rst
diff --git a/docs/source/reference/api/opendataset/AnimalsWithAttributes2.rst b/docs/source/reference/api/opendataset/AnimalsWithAttributes2.rst
diff --git a/docs/source/reference/api/opendataset/BDD100K.rst b/docs/source/reference/api/opendataset/BDD100K.rst
diff --git a/docs/source/reference/api/opendataset/BSTLD.rst b/docs/source/reference/api/opendataset/BSTLD.rst
diff --git a/docs/source/reference/api/opendataset/BioIDFace.rst b/docs/source/reference/api/opendataset/BioIDFace.rst
diff --git a/docs/source/reference/api/opendataset/CACD.rst b/docs/source/reference/api/opendataset/CACD.rst
diff --git a/docs/source/reference/api/opendataset/CADC.rst b/docs/source/reference/api/opendataset/CADC.rst
diff --git a/docs/source/reference/api/opendataset/CCPD.rst b/docs/source/reference/api/opendataset/CCPD.rst
diff --git a/docs/source/reference/api/opendataset/COVIDChestXRay.rst b/docs/source/reference/api/opendataset/COVIDChestXRay.rst
diff --git a/docs/source/reference/api/opendataset/COVID_CT.rst b/docs/source/reference/api/opendataset/COVID_CT.rst
diff --git a/docs/source/reference/api/opendataset/CarConnection.rst b/docs/source/reference/api/opendataset/CarConnection.rst
diff --git a/docs/source/reference/api/opendataset/CoinImage.rst b/docs/source/reference/api/opendataset/CoinImage.rst
diff --git a/docs/source/reference/api/opendataset/CompCars.rst b/docs/source/reference/api/opendataset/CompCars.rst
diff --git a/docs/source/reference/api/opendataset/DAVIS2017.rst b/docs/source/reference/api/opendataset/DAVIS2017.rst
diff --git a/docs/source/reference/api/opendataset/DeepRoute.rst b/docs/source/reference/api/opendataset/DeepRoute.rst
diff --git a/docs/source/reference/api/opendataset/DogsVsCats.rst b/docs/source/reference/api/opendataset/DogsVsCats.rst
diff --git a/docs/source/reference/api/opendataset/DownsampledImagenet.rst b/docs/source/reference/api/opendataset/DownsampledImagenet.rst
diff --git a/docs/source/reference/api/opendataset/Elpv.rst b/docs/source/reference/api/opendataset/Elpv.rst
diff --git a/docs/source/reference/api/opendataset/FLIC.rst b/docs/source/reference/api/opendataset/FLIC.rst
diff --git a/docs/source/reference/api/opendataset/FSDD.rst b/docs/source/reference/api/opendataset/FSDD.rst
diff --git a/docs/source/reference/api/opendataset/Flower.rst b/docs/source/reference/api/opendataset/Flower.rst
diff --git a/docs/source/reference/api/opendataset/HalpeFullBody.rst b/docs/source/reference/api/opendataset/HalpeFullBody.rst
diff --git a/docs/source/reference/api/opendataset/HardHatWorkers.rst b/docs/source/reference/api/opendataset/HardHatWorkers.rst
diff --git a/docs/source/reference/api/opendataset/HeadPoseImage.rst b/docs/source/reference/api/opendataset/HeadPoseImage.rst
diff --git a/docs/source/reference/api/opendataset/ImageEmotion.rst b/docs/source/reference/api/opendataset/ImageEmotion.rst
diff --git a/docs/source/reference/api/opendataset/JHU_CROWD.rst b/docs/source/reference/api/opendataset/JHU_CROWD.rst
diff --git a/docs/source/reference/api/opendataset/KenyanFood.rst b/docs/source/reference/api/opendataset/KenyanFood.rst
diff --git a/docs/source/reference/api/opendataset/KylbergTexture.rst b/docs/source/reference/api/opendataset/KylbergTexture.rst
diff --git a/docs/source/reference/api/opendataset/LISATrafficLight.rst b/docs/source/reference/api/opendataset/LISATrafficLight.rst
diff --git a/docs/source/reference/api/opendataset/LISATrafficSign.rst b/docs/source/reference/api/opendataset/LISATrafficSign.rst
diff --git a/docs/source/reference/api/opendataset/LeedsSportsPose.rst b/docs/source/reference/api/opendataset/LeedsSportsPose.rst
diff --git a/docs/source/reference/api/opendataset/NeolixOD.rst b/docs/source/reference/api/opendataset/NeolixOD.rst
diff --git a/docs/source/reference/api/opendataset/Newsgroups20.rst b/docs/source/reference/api/opendataset/Newsgroups20.rst
diff --git a/docs/source/reference/api/opendataset/NightOwls.rst b/docs/source/reference/api/opendataset/NightOwls.rst
diff --git a/docs/source/reference/api/opendataset/RP2K.rst b/docs/source/reference/api/opendataset/RP2K.rst
diff --git a/docs/source/reference/api/opendataset/THCHS30.rst b/docs/source/reference/api/opendataset/THCHS30.rst
diff --git a/docs/source/reference/api/opendataset/THUCNews.rst b/docs/source/reference/api/opendataset/THUCNews.rst
diff --git a/docs/source/reference/api/opendataset/TLR.rst b/docs/source/reference/api/opendataset/TLR.rst
diff --git a/docs/source/reference/api/opendataset/UAVDT.rst b/docs/source/reference/api/opendataset/UAVDT.rst