diff --git a/docs/api/api.rst b/docs/api/api.rst index aebeac5..4cc83b8 100644 --- a/docs/api/api.rst +++ b/docs/api/api.rst @@ -1,3 +1,5 @@ +.. _api: + API === diff --git a/docs/api/contents.rst b/docs/api/contents.rst deleted file mode 100644 index 8d590fa..0000000 --- a/docs/api/contents.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _api: - -API DOC -========= - -.. toctree:: - - api - device - enums - types - utils diff --git a/docs/api/device.rst b/docs/api/device.rst index bb4e193..8b55eaa 100644 --- a/docs/api/device.rst +++ b/docs/api/device.rst @@ -1,3 +1,5 @@ +.. _device: + Device ====== diff --git a/docs/api/enums.rst b/docs/api/enums.rst index 29e02da..0d56388 100644 --- a/docs/api/enums.rst +++ b/docs/api/enums.rst @@ -1,3 +1,5 @@ +.. _enums: + Enums ===== diff --git a/docs/api/types.rst b/docs/api/types.rst index 3fa342a..7f058db 100644 --- a/docs/api/types.rst +++ b/docs/api/types.rst @@ -1,3 +1,5 @@ +.. _types: + Types ===== diff --git a/docs/api/utils.rst b/docs/api/utils.rst index 443278e..f4479a5 100644 --- a/docs/api/utils.rst +++ b/docs/api/utils.rst @@ -1,3 +1,5 @@ +.. _utils: + Utils ===== diff --git a/docs/index.rst b/docs/index.rst index 71ea681..d9f5f13 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,19 +7,84 @@ MYNT® EYE S SDK =============== .. toctree:: - :maxdepth: 2 - :titlesonly: + :caption: Product + :maxdepth: 6 - src/mynteye/contents - src/sdk/contents - src/firmware/contents - src/data/contents - src/control/contents - src/log/contents - src/wrapper/contents - src/analytics/contents - src/slam/contents - api/contents + src/mynteye/product_description + src/mynteye/product_surface + src/mynteye/pro_intro + src/mynteye/support_resolutions + src/mynteye/imu_coord + +.. toctree:: + :caption: SDK + :maxdepth: 5 + + src/sdk/SDKContents + src/sdk/InstallContents + src/sdk/ProjectContents + src/sdk/LogContents + +.. toctree:: + :caption: Firmware + :maxdepth: 4 + + src/firmware/FirmwareContents + src/firmware/FirmwareUpdate + src/firmware/UpdateLog + +.. toctree:: + :caption: SDK Sample + :maxdepth: 13 + + src/data/get_device_info + src/data/get_img_params + src/data/get_imu_params + src/data/get_stereo + src/data/get_stereo_rectified + src/data/ get_disparity + src/data/get_depth + src/data/get_points + src/data/get_imu + src/data/get_imu_correspondence + src/data/get_from_callbacks + src/data/get_with_plugin + +.. toctree:: + :caption: SDK Tools + :maxdepth: 3 + + src/analytics/analytics_dataset + src/analytics/analytics_imu + src/analytics/analytics_stamp + +.. toctree:: + :caption: Open Source Support + :maxdepth: 7 + + src/slam/vins + src/slam/vins_fusion + src/slam/orb_slam2 + src/slam/okvis + src/slam/viorb + src/slam/maplab + +.. toctree:: + :caption: API DOC + :maxdepth: 6 + + api/api + api/device + api/enums + api/types + api/utils + +.. toctree:: + :caption: Technical Support + :maxdepth: 3 + + api/api + api/device .. Indices and tables diff --git a/docs/src/analytics/dataset.rst b/docs/src/analytics/analytics_dataset.rst similarity index 98% rename from docs/src/analytics/dataset.rst rename to docs/src/analytics/analytics_dataset.rst index 6786350..6efbf0d 100644 --- a/docs/src/analytics/dataset.rst +++ b/docs/src/analytics/analytics_dataset.rst @@ -1,6 +1,6 @@ -.. _dataset: +.. _analytics_dataset: -Recording data sets +Recording Data Sets ==================== The SDK provides the tool ``record`` for recording data sets. Tool details can be seen in `tools/README.md `_ . diff --git a/docs/src/analytics/analytics_stamp.rst b/docs/src/analytics/analytics_stamp.rst index 931bdda..2b6f841 100644 --- a/docs/src/analytics/analytics_stamp.rst +++ b/docs/src/analytics/analytics_stamp.rst @@ -1,6 +1,6 @@ .. _analytics_stamp: -Analyze time stamps +Analyze Time Stamps ==================== SDK provides a script for timestamp analysis ``stamp_analytics.py`` . Tool details are visible in `tools/README.md `_ . diff --git a/docs/src/analytics/contents.rst b/docs/src/analytics/contents.rst deleted file mode 100644 index a8d258d..0000000 --- a/docs/src/analytics/contents.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _analytics: - -Data Analytics -=============== - -.. toctree:: - - dataset - analytics_imu - analytics_stamp diff --git a/docs/src/data/get_depth.rst b/docs/src/data/get_depth.rst index fcd07e1..775dbd1 100644 --- a/docs/src/data/get_depth.rst +++ b/docs/src/data/get_depth.rst @@ -1,4 +1,4 @@ -.. _get_depth: +.. _data_get_depth: Get depth image =============== diff --git a/docs/src/data/get_device_info.rst b/docs/src/data/get_device_info.rst index ebc77a0..9dae90f 100644 --- a/docs/src/data/get_device_info.rst +++ b/docs/src/data/get_device_info.rst @@ -1,4 +1,4 @@ -.. _get_device_info: +.. _data_get_device_info: Get device information ====================== diff --git a/docs/src/data/get_disparity.rst b/docs/src/data/get_disparity.rst index 8dc81c9..caa731d 100644 --- a/docs/src/data/get_disparity.rst +++ b/docs/src/data/get_disparity.rst @@ -1,4 +1,4 @@ -.. _get_disparity: +.. _data_get_disparity: Get disparity image =================== diff --git a/docs/src/data/get_from_callbacks.rst b/docs/src/data/get_from_callbacks.rst index 2fc2a0d..a7ec7e7 100644 --- a/docs/src/data/get_from_callbacks.rst +++ b/docs/src/data/get_from_callbacks.rst @@ -1,4 +1,4 @@ -.. _get_from_callbacks: +.. _data_get_from_callbacks: Get data from callbacks ======================== diff --git a/docs/src/data/get_img_params.rst b/docs/src/data/get_img_params.rst index b4bf635..ee512dd 100644 --- a/docs/src/data/get_img_params.rst +++ b/docs/src/data/get_img_params.rst @@ -1,4 +1,4 @@ -.. _get_img_params: +.. _data_get_img_params: Get image calibration parameters ================================ diff --git a/docs/src/data/get_imu.rst b/docs/src/data/get_imu.rst index 05460ed..1eed374 100644 --- a/docs/src/data/get_imu.rst +++ b/docs/src/data/get_imu.rst @@ -1,4 +1,4 @@ -.. _get_imu_data: +.. _data_get_imu_data: Get IMU data ============= diff --git a/docs/src/data/get_imu_correspondence.rst b/docs/src/data/get_imu_correspondence.rst index 32748d1..666913a 100644 --- a/docs/src/data/get_imu_correspondence.rst +++ b/docs/src/data/get_imu_correspondence.rst @@ -1,4 +1,4 @@ -.. _get_imu_correspondence: +.. _data_get_imu_correspondence: Get IMU data with timestamp correspondence =========================================== diff --git a/docs/src/data/get_imu_params.rst b/docs/src/data/get_imu_params.rst index f0aac6f..2bd01c1 100644 --- a/docs/src/data/get_imu_params.rst +++ b/docs/src/data/get_imu_params.rst @@ -1,4 +1,4 @@ -.. _get_imu_params: +.. _data_get_imu_params: Get IMU calibration parameters ============================== diff --git a/docs/src/data/get_points.rst b/docs/src/data/get_points.rst index a934cdd..9df0609 100644 --- a/docs/src/data/get_points.rst +++ b/docs/src/data/get_points.rst @@ -1,4 +1,4 @@ -.. _get_points: +.. _data_get_points: Get point image ================ diff --git a/docs/src/data/get_stereo.rst b/docs/src/data/get_stereo.rst index afa1e5a..676ef0e 100644 --- a/docs/src/data/get_stereo.rst +++ b/docs/src/data/get_stereo.rst @@ -1,4 +1,4 @@ -.. _get_stereo: +.. _data_get_stereo: Get original binocular image ============================= diff --git a/docs/src/data/get_stereo_rectified.rst b/docs/src/data/get_stereo_rectified.rst index 653b359..df6b649 100644 --- a/docs/src/data/get_stereo_rectified.rst +++ b/docs/src/data/get_stereo_rectified.rst @@ -1,4 +1,4 @@ -.. _get_stereo_rectified: +.. _data_get_stereo_rectified: Get stereo camera correction image ================================== diff --git a/docs/src/data/get_with_plugin.rst b/docs/src/data/get_with_plugin.rst index 72b13c0..75ab8ed 100644 --- a/docs/src/data/get_with_plugin.rst +++ b/docs/src/data/get_with_plugin.rst @@ -1,4 +1,4 @@ -.. _get_with_plugin: +.. _data_get_with_plugin: Using the plugin to get data ============================ diff --git a/docs/src/data/save_params.rst b/docs/src/data/save_params.rst index 43a4dd2..fa2900c 100644 --- a/docs/src/data/save_params.rst +++ b/docs/src/data/save_params.rst @@ -1,4 +1,4 @@ -.. _save_params: +.. _data_save_params: Save device infomation and parameters ===================================== diff --git a/docs/src/data/write_img_params.rst b/docs/src/data/write_img_params.rst index 268d0a0..1950f0b 100644 --- a/docs/src/data/write_img_params.rst +++ b/docs/src/data/write_img_params.rst @@ -1,4 +1,4 @@ -.. _write_img_params: +.. _data_write_img_params: Write image parameters ======================= diff --git a/docs/src/data/write_imu_params.rst b/docs/src/data/write_imu_params.rst index da2641b..098338c 100644 --- a/docs/src/data/write_imu_params.rst +++ b/docs/src/data/write_imu_params.rst @@ -1,4 +1,4 @@ -.. _write_imu_params: +.. _data_write_imu_params: Write IMU parameters ===================== diff --git a/docs/src/firmware/FirmwareContents.rst b/docs/src/firmware/FirmwareContents.rst new file mode 100644 index 0000000..09e8f79 --- /dev/null +++ b/docs/src/firmware/FirmwareContents.rst @@ -0,0 +1,9 @@ +.. _firmware: + +Firmware Description +================== + +.. toctree:: + :maxdepth: 2 + + applicable \ No newline at end of file diff --git a/docs/src/firmware/contents.rst b/docs/src/firmware/FirmwareUpdate.rst similarity index 60% rename from docs/src/firmware/contents.rst rename to docs/src/firmware/FirmwareUpdate.rst index 264067a..356b58d 100644 --- a/docs/src/firmware/contents.rst +++ b/docs/src/firmware/FirmwareUpdate.rst @@ -1,11 +1,11 @@ .. _firmware: -MYNT® EYE Firmware +Upgrade Firmware ================== .. toctree:: + :maxdepth: 2 - applicable upgrade stm_update - from_v1.rst + from_v1 diff --git a/docs/src/firmware/UpdateLog.rst b/docs/src/firmware/UpdateLog.rst new file mode 100644 index 0000000..021635d --- /dev/null +++ b/docs/src/firmware/UpdateLog.rst @@ -0,0 +1,5 @@ +Update Log +================== + +.. toctree:: + :maxdepth: 2 diff --git a/docs/src/firmware/from_v1.rst b/docs/src/firmware/from_v1.rst index a3b5e2e..e5ee494 100644 --- a/docs/src/firmware/from_v1.rst +++ b/docs/src/firmware/from_v1.rst @@ -1,4 +1,4 @@ -.. _sdk_from_v1: +.. _firmware_from_v1: Change from SDK 1.x to 2.x =========================== diff --git a/docs/src/mynteye/contents.rst b/docs/src/mynteye/contents.rst deleted file mode 100644 index 7b7b1f2..0000000 --- a/docs/src/mynteye/contents.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _mynteye: - -MYNT® EYE product introduction -============================== - -.. toctree:: - - intro - surface_s1030 - imu_coord_s1030 - spec_s1030 - surface_s2100 - imu_coord_s2100 - spec_s2100 \ No newline at end of file diff --git a/docs/src/mynteye/imu_coord.rst b/docs/src/mynteye/imu_coord.rst new file mode 100644 index 0000000..27bda43 --- /dev/null +++ b/docs/src/mynteye/imu_coord.rst @@ -0,0 +1,11 @@ +.. _mynteye: + +IMU Coordinata System +================== + +.. toctree:: + :maxdepth: 2 + + imu_coord_s1030 + imu_coord_s2100 + \ No newline at end of file diff --git a/docs/src/mynteye/pro_intro.rst b/docs/src/mynteye/pro_intro.rst new file mode 100644 index 0000000..68a293d --- /dev/null +++ b/docs/src/mynteye/pro_intro.rst @@ -0,0 +1,10 @@ +.. _mynteye: + +Product Introduction +============================== + +.. toctree:: + :maxdepth: 2 + + spec_s1030 + spec_s2100 \ No newline at end of file diff --git a/docs/src/mynteye/intro.rst b/docs/src/mynteye/product_description.rst similarity index 98% rename from docs/src/mynteye/intro.rst rename to docs/src/mynteye/product_description.rst index 1b00496..96e638f 100644 --- a/docs/src/mynteye/intro.rst +++ b/docs/src/mynteye/product_description.rst @@ -1,6 +1,6 @@ -.. _mynteye_intro: +.. _mynteye: -Product description +Product Description ==================== MYNT® EYE S Series includes MYNT EYE S, MYNT EYE SE and MYNT EYE SC. The “Binocular + IMU” inertial navigation solution for MYNT® EYE S Series provides accurate six-axis complementary data for vSLAM applications and is more accurate and robust than other single solutions. diff --git a/docs/src/mynteye/product_surface.rst b/docs/src/mynteye/product_surface.rst new file mode 100644 index 0000000..389b93c --- /dev/null +++ b/docs/src/mynteye/product_surface.rst @@ -0,0 +1,11 @@ +.. _mynteye: + +Surface +================== + +.. toctree:: + :maxdepth: 2 + + surface_s1030 + surface_s2100 + \ No newline at end of file diff --git a/docs/src/sdk/contents.rst b/docs/src/sdk/InstallContents.rst similarity index 60% rename from docs/src/sdk/contents.rst rename to docs/src/sdk/InstallContents.rst index 69cf0e2..c6bc918 100644 --- a/docs/src/sdk/contents.rst +++ b/docs/src/sdk/InstallContents.rst @@ -1,16 +1,14 @@ .. _sdk: -MYNT® EYE SDK -============= +Installation and Use +================== .. toctree:: + :maxdepth: 2 - changelog - platform ppa_install_ubuntu - exe_install_windows source_install_ubuntu + exe_install_windows source_install_windows - install_macos install_ros - without_opencv + without_opencv \ No newline at end of file diff --git a/docs/src/sdk/LogContents.rst b/docs/src/sdk/LogContents.rst new file mode 100644 index 0000000..7d4dbe1 --- /dev/null +++ b/docs/src/sdk/LogContents.rst @@ -0,0 +1,9 @@ +.. _sdk: + +Update Log +================== + +.. toctree:: + :maxdepth: 2 + + changelog diff --git a/docs/src/sdk/ProjectContents.rst b/docs/src/sdk/ProjectContents.rst new file mode 100644 index 0000000..e9dea63 --- /dev/null +++ b/docs/src/sdk/ProjectContents.rst @@ -0,0 +1,12 @@ +.. _sdk: + +Program Reference +================== + +.. toctree:: + :maxdepth: 2 + + // 缺少: + cmake + vs2017 + qtcreator diff --git a/docs/src/sdk/SDKContents.rst b/docs/src/sdk/SDKContents.rst new file mode 100644 index 0000000..2096f34 --- /dev/null +++ b/docs/src/sdk/SDKContents.rst @@ -0,0 +1,9 @@ +.. _sdk: + +SDK Description +================== + +.. toctree:: + :maxdepth: 2 + + platform diff --git a/docs/src/sdk/platform.rst b/docs/src/sdk/platform.rst index 735b275..70d3533 100644 --- a/docs/src/sdk/platform.rst +++ b/docs/src/sdk/platform.rst @@ -1,4 +1,4 @@ -.. _sdk_platform: +.. _sdk: Supported platforms ==================== diff --git a/docs/src/slam/contents.rst b/docs/src/slam/contents.rst deleted file mode 100644 index aa5b82b..0000000 --- a/docs/src/slam/contents.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _slam: - -Open Source project Support -============================ - -.. toctree:: - - vins - vins_fusion - orb_slam2 - okvis - viorb - maplab diff --git a/docs/src/slam/maplab.rst b/docs/src/slam/maplab.rst index bdc8a62..34d7d0d 100644 --- a/docs/src/slam/maplab.rst +++ b/docs/src/slam/maplab.rst @@ -1,4 +1,4 @@ -.. _slam_maplab: +.. _maplab: How to use in `Maplab `_ x =============================================================== diff --git a/docs/src/slam/okvis.rst b/docs/src/slam/okvis.rst index 35ffc89..20c0ae6 100644 --- a/docs/src/slam/okvis.rst +++ b/docs/src/slam/okvis.rst @@ -1,4 +1,4 @@ -.. _slam_okvis: +.. _okvis: How to use in `OKVIS `_ ============================================================= diff --git a/docs/src/slam/orb_slam2.rst b/docs/src/slam/orb_slam2.rst index a26a83f..a6a1d05 100644 --- a/docs/src/slam/orb_slam2.rst +++ b/docs/src/slam/orb_slam2.rst @@ -1,4 +1,4 @@ -.. _slam_orb_slam2: +.. _orb_slam2: How to use in `ORB_SLAM2 `_ ================================================================== diff --git a/docs/src/slam/vins.rst b/docs/src/slam/vins.rst index a3a0d82..e437f17 100644 --- a/docs/src/slam/vins.rst +++ b/docs/src/slam/vins.rst @@ -1,4 +1,4 @@ -.. _slam_vins: +.. _vins: How to use in `VINS-Mono `_ ================================================================================ diff --git a/docs/src/slam/vins_fusion.rst b/docs/src/slam/vins_fusion.rst index 9bb13cf..ab66633 100644 --- a/docs/src/slam/vins_fusion.rst +++ b/docs/src/slam/vins_fusion.rst @@ -1,4 +1,4 @@ -.. _slam_vins_fusion: +.. _vins_fusion: How to use in `VINS-Fusion `_ ==================================================================================== diff --git a/docs/src/slam/viorb.rst b/docs/src/slam/viorb.rst index ac48dd1..998c36f 100644 --- a/docs/src/slam/viorb.rst +++ b/docs/src/slam/viorb.rst @@ -1,4 +1,4 @@ -.. _slam_viorb: +.. _viorb: How to use in `VIORB `_ ================================================================