docs(*): update docs

2019-06-04 10:08:13 +08:00 · 2019-06-04 10:08:13 +08:00 · 82719ed1f0
commit 82719ed1f0
parent 7ef64208be
46 changed files with 199 additions and 99 deletions
--- a/docs/api/api.rst
+++ b/docs/api/api.rst
@ -1,3 +1,5 @@
+.. _api:
+
 API
 ===

--- a/docs/api/contents.rst
+++ b/docs/api/contents.rst
@ -1,12 +0,0 @@
-.. _api:
-
-API DOC
-=========
-
-.. toctree::
-
-   api
-   device
-   enums
-   types
-   utils
--- a/docs/api/device.rst
+++ b/docs/api/device.rst
@ -1,3 +1,5 @@
+.. _device:
+
 Device
 ======

--- a/docs/api/enums.rst
+++ b/docs/api/enums.rst
@ -1,3 +1,5 @@
+.. _enums:
+
 Enums
 =====

--- a/docs/api/types.rst
+++ b/docs/api/types.rst
@ -1,3 +1,5 @@
+.. _types:
+
 Types
 =====

--- a/docs/api/utils.rst
+++ b/docs/api/utils.rst
@ -1,3 +1,5 @@
+.. _utils:
+
 Utils
 =====

--- 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
--- a/docs/src/analytics/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 <https://github.com/slightech/MYNT-EYE-S-SDK/tree/master/tools>`_ .
--- 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 <https://github.com/slightech/MYNT-EYE-S-SDK/tree/master/tools>`_ .
--- a/docs/src/analytics/contents.rst
+++ b/docs/src/analytics/contents.rst
@ -1,10 +0,0 @@
-.. _analytics:
-
-Data Analytics
-===============
-
-.. toctree::
-
-   dataset
-   analytics_imu
-   analytics_stamp
--- 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
 ===============
--- 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
 ======================
--- 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
 ===================
--- 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
 ========================
--- 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
 ================================
--- 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
 =============
--- 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
 ===========================================
--- 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
 ==============================
--- 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
 ================
--- 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
 =============================
--- 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
 ==================================
--- 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
 ============================
--- 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
 =====================================
--- 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
 =======================
--- 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
 =====================
--- a/docs/src/firmware/FirmwareContents.rst
+++ b/docs/src/firmware/FirmwareContents.rst
@ -0,0 +1,9 @@
+.. _firmware:
+
+Firmware Description
+==================
+
+.. toctree::
+   :maxdepth: 2
+
+   applicable
--- a/docs/src/firmware/FirmwareUpdate.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
--- a/docs/src/firmware/UpdateLog.rst
+++ b/docs/src/firmware/UpdateLog.rst
@ -0,0 +1,5 @@
+Update Log
+==================
+
+.. toctree::
+   :maxdepth: 2
--- 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
 ===========================
--- a/docs/src/mynteye/contents.rst
+++ b/docs/src/mynteye/contents.rst
@ -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
--- a/docs/src/mynteye/imu_coord.rst
+++ b/docs/src/mynteye/imu_coord.rst
@ -0,0 +1,11 @@
+.. _mynteye:
+
+IMU Coordinata System
+==================
+
+.. toctree::
+   :maxdepth: 2
+
+   imu_coord_s1030
+   imu_coord_s2100
+  
--- a/docs/src/mynteye/pro_intro.rst
+++ b/docs/src/mynteye/pro_intro.rst
@ -0,0 +1,10 @@
+.. _mynteye:
+
+Product Introduction
+==============================
+
+.. toctree::
+   :maxdepth: 2
+
+   spec_s1030
+   spec_s2100
--- a/docs/src/mynteye/product_description.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.
--- a/docs/src/mynteye/product_surface.rst
+++ b/docs/src/mynteye/product_surface.rst
@ -0,0 +1,11 @@
+.. _mynteye:
+
+Surface
+==================
+
+.. toctree::
+   :maxdepth: 2
+
+   surface_s1030
+   surface_s2100
+  
--- a/docs/src/sdk/InstallContents.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
--- a/docs/src/sdk/LogContents.rst
+++ b/docs/src/sdk/LogContents.rst
@ -0,0 +1,9 @@
+.. _sdk:
+
+Update Log
+==================
+
+.. toctree::
+   :maxdepth: 2
+
+   changelog
--- a/docs/src/sdk/ProjectContents.rst
+++ b/docs/src/sdk/ProjectContents.rst
@ -0,0 +1,12 @@
+.. _sdk:
+
+Program Reference
+==================
+
+.. toctree::
+   :maxdepth: 2
+
+   // 缺少:
+   cmake
+   vs2017
+   qtcreator
--- a/docs/src/sdk/SDKContents.rst
+++ b/docs/src/sdk/SDKContents.rst
@ -0,0 +1,9 @@
+.. _sdk:
+
+SDK Description
+==================
+
+.. toctree::
+   :maxdepth: 2
+
+   platform
--- a/docs/src/sdk/platform.rst
+++ b/docs/src/sdk/platform.rst
@ -1,4 +1,4 @@
-.. _sdk_platform:
+.. _sdk:

 Supported platforms
 ====================
--- a/docs/src/slam/contents.rst
+++ b/docs/src/slam/contents.rst
@ -1,13 +0,0 @@
-.. _slam:
-
-Open Source project Support
-============================
-
-.. toctree::
-
-   vins
-   vins_fusion
-   orb_slam2
-   okvis
-   viorb
-   maplab
--- a/docs/src/slam/maplab.rst
+++ b/docs/src/slam/maplab.rst
@ -1,4 +1,4 @@
-.. _slam_maplab:
+.. _maplab:

 How to use in `Maplab <https://github.com/ethz-asl/maplab>`_ x
 ===============================================================
--- a/docs/src/slam/okvis.rst
+++ b/docs/src/slam/okvis.rst
@ -1,4 +1,4 @@
-.. _slam_okvis:
+.. _okvis:

 How to use in `OKVIS <https://github.com/ethz-asl/okvis>`_
 =============================================================
--- 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 <https://github.com/raulmur/ORB_SLAM2>`_
 ==================================================================
--- 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 <https://github.com/HKUST-Aerial-Robotics/VINS-Mono>`_
 ================================================================================
--- 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 <https://github.com/HKUST-Aerial-Robotics/Vins-Fusion>`_
 ====================================================================================
--- a/docs/src/slam/viorb.rst
+++ b/docs/src/slam/viorb.rst
@ -1,4 +1,4 @@
-.. _slam_viorb:
+.. _viorb:

 How to use in `VIORB <https://github.com/jingpang/LearnVIORB>`_
 ================================================================