新版文档更新

2019-06-25 11:09:49 +08:00 · 2019-06-25 11:09:49 +08:00 · fb37635a72
commit fb37635a72
parent 82719ed1f0
36 changed files with 120 additions and 110 deletions
--- a/docs/api/contents.rst
+++ b/docs/api/contents.rst
@ -0,0 +1,10 @@
+API DOCS
+==============
+
+.. toctree::
+
+   api
+   device
+   enums
+   types
+   utils
--- a/docs/index.rst
+++ b/docs/index.rst
@ -7,84 +7,17 @@ MYNT® EYE S SDK
 ===============

 .. toctree::
-   :caption: Product
-   :maxdepth: 6
+   :titlesonly:
+   :maxdepth: 2

-   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
+   src/mynteye/contents
+   src/sdk/contents
+   src/firmware/contents
+   src/data/contents
+   src/analytics/contents
+   src/slam/contents
+   api/contents
+   src/support/contents

 ..
  Indices and tables
--- a/docs/src/analytics/contents.rst
+++ b/docs/src/analytics/contents.rst
@ -0,0 +1,9 @@
+SDK TOOLS
+==================
+
+.. toctree::
+   :maxdepth: 2
+
+   analytics_dataset
+   analytics_imu
+   analytics_stamp
--- a/docs/src/data/contents.rst
+++ b/docs/src/data/contents.rst
@ -1,6 +1,4 @@
-.. _data:
-
-MYNT® EYE Data
+SDK SAMPLES
 ==============

 .. toctree::
@ -17,6 +15,3 @@ MYNT® EYE Data
   get_imu_correspondence
   get_from_callbacks
   get_with_plugin
-   save_params
-   write_img_params
-   write_imu_params
--- a/docs/src/data/get_depth.rst
+++ b/docs/src/data/get_depth.rst
@ -1,6 +1,6 @@
 .. _data_get_depth:

-Get depth image
+Get Depth Image
 ===============

 Depth images belongs to the upper layer of synthetic data. You need to start the ``EnableStreamData()`` beforehand, to get it through ``GetStreamData()``. The depth image type is CV_16UC1. In addition, it should be check not be empty before use.
--- a/docs/src/data/get_device_info.rst
+++ b/docs/src/data/get_device_info.rst
@ -1,6 +1,6 @@
 .. _data_get_device_info:

-Get device information
+Get Device Information
 ======================

 Use ``GetInfo()`` function to get various current information values.
--- a/docs/src/data/get_disparity.rst
+++ b/docs/src/data/get_disparity.rst
@ -1,6 +1,6 @@
 .. _data_get_disparity:

-Get disparity image
+Get Disparity Image
 ===================

 Disparity image belongs to the upper layer of synthetic data. You need to start the ``EnableStreamData()`` beforehand, to get it through ``GetStreamData()``. In addition, it should be check not be empty before use.
--- a/docs/src/data/get_from_callbacks.rst
+++ b/docs/src/data/get_from_callbacks.rst
@ -1,6 +1,6 @@
 .. _data_get_from_callbacks:

-Get data from callbacks
+Get Data From Callbacks
 ========================

 API offers function ``SetStreamCallback()`` and ``SetMotionCallback()`` to set callbacks for various data.
--- a/docs/src/data/get_img_params.rst
+++ b/docs/src/data/get_img_params.rst
@ -1,6 +1,6 @@
 .. _data_get_img_params:

-Get image calibration parameters
+Get Image Calibration Parameters
 ================================

 Use ``GetIntrinsics()`` & ``GetExtrinsics()`` to get image calibration parameters.
--- a/docs/src/data/get_imu.rst
+++ b/docs/src/data/get_imu.rst
@ -1,6 +1,6 @@
 .. _data_get_imu_data:

-Get IMU data
+Get IMU Data
 =============

 The API offers ``Start()`` / ``Stop()`` function to start/stop capturing data. You can set the argument to``Source::MOTION_TRACKING`` to capture IMU data only, or set it to ``Source::ALL`` to capture both image and IMU data.
--- a/docs/src/data/get_imu_correspondence.rst
+++ b/docs/src/data/get_imu_correspondence.rst
@ -1,6 +1,6 @@
 .. _data_get_imu_correspondence:

-Get IMU data with timestamp correspondence
+Get IMU Data With Timestamp Correspondence
 ===========================================

 If wanna get image with timestamp in the middle of IMU datas, you could call `EnableTimestampCorrespondence()`` to enable this feature.
--- a/docs/src/data/get_imu_params.rst
+++ b/docs/src/data/get_imu_params.rst
@ -1,6 +1,6 @@
 .. _data_get_imu_params:

-Get IMU calibration parameters
+Get IMU Calibration Parameters
 ==============================

 Use ``GetMotionIntrinsics()`` & ``GetMotionExtrinsics()`` to get current IMU calibration parameters.
--- a/docs/src/data/get_points.rst
+++ b/docs/src/data/get_points.rst
@ -1,6 +1,6 @@
 .. _data_get_points:

-Get point image
+Get Point Image
 ================

 Point images belongs to upper layer of synthetic data. To get this kind of data through ``GetStreamData()``, you need to start the ``EnableStreamData()`` beforehand. It should be check not empty before use.
--- a/docs/src/data/get_stereo.rst
+++ b/docs/src/data/get_stereo.rst
@ -1,6 +1,6 @@
 .. _data_get_stereo:

-Get original binocular image
+Get Original Binocular Image
 =============================

 Use ``Start()`` or ``Stop()`` , to start or stop data capturing. If you only need the image data, use ``Source::VIDEO_STREAMING`` .
--- a/docs/src/data/get_stereo_rectified.rst
+++ b/docs/src/data/get_stereo_rectified.rst
@ -1,6 +1,6 @@
 .. _data_get_stereo_rectified:

-Get stereo camera correction image
+Get Stereo Camera Correction Image
 ==================================

 The ``GetStreamData()`` API provided can only get the raw data of the hardware, for example, the stereo camera raw image.
--- a/docs/src/data/get_with_plugin.rst
+++ b/docs/src/data/get_with_plugin.rst
@ -1,6 +1,6 @@
 .. _data_get_with_plugin:

-Using the plugin to get data
+Using The Plugin To Get Data
 ============================

 API provides a ``EnablePlugin()`` function to enable plugins under a path.
--- a/docs/src/data/save_params.rst
+++ b/docs/src/data/save_params.rst
@ -1,6 +1,6 @@
 .. _data_save_params:

-Save device infomation and parameters
+Save Device Infomation And Parameters
 =====================================

 The SDK provides a tool ``save_all_infos`` for save information and parameters. For more information, please read `tools/README.md <https://github.com/slightech/MYNT-EYE-S-SDK/tree/master/tools>`_ .
--- a/docs/src/data/write_img_params.rst
+++ b/docs/src/data/write_img_params.rst
@ -1,6 +1,6 @@
 .. _data_write_img_params:

-Write image parameters
+Write Image Parameters
 =======================

 The SDK provides a tool ``img_params_writer`` for writing image parameters. For details, read `tools/README.md <https://github.com/slightech/MYNT-EYE-S-SDK/tree/master/tools>`_ .
--- a/docs/src/data/write_imu_params.rst
+++ b/docs/src/data/write_imu_params.rst
@ -1,6 +1,6 @@
 .. _data_write_imu_params:

-Write IMU parameters
+Write IMU Parameters
 =====================

 SDK provides the tool ``imu_params_writer`` to write IMU parameters. For deltail, please read `tools/README.md <https://github.com/slightech/MYNT-EYE-S-SDK/tree/master/tools>`_ .
--- a/docs/src/firmware/contents.rst
+++ b/docs/src/firmware/contents.rst
@ -0,0 +1,9 @@
+FIRMWARE
+==================
+
+.. toctree::
+   :maxdepth: 2
+
+   FirmwareContents
+   FirmwareUpdate
+   UpdateLogToDos
--- a/docs/src/mynteye/contents.rst
+++ b/docs/src/mynteye/contents.rst
@ -0,0 +1,11 @@
+PRODUCT
+==================
+
+.. toctree::
+   :maxdepth: 2
+
+   product_description
+   product_surface
+   pro_intro
+   support_resolutions
+   imu_coord
--- a/docs/src/sdk/LogContents.rst
+++ b/docs/src/sdk/LogContents.rst
@ -1,6 +1,6 @@
 .. _sdk:

-Update Log
+Change Log
 ==================

 .. toctree::
--- a/docs/src/sdk/ProjectContents.rst
+++ b/docs/src/sdk/ProjectContents.rst
@ -1,6 +1,6 @@
 .. _sdk:

-Program Reference
+Project Reference
 ==================

 .. toctree::
--- a/docs/src/sdk/changelog.rst
+++ b/docs/src/sdk/changelog.rst
@ -1,6 +1,6 @@
 .. _sdk_changelog:

-Changelog
+Change Log
 =========

 2019-04-19(v2.3.7)
--- a/docs/src/sdk/contents.rst
+++ b/docs/src/sdk/contents.rst
@ -0,0 +1,10 @@
+SDK
+==================
+
+.. toctree::
+   :maxdepth: 5
+
+   platform
+   InstallContents
+   ProjectContentsToDos
+   changelog
--- a/docs/src/sdk/platform.rst
+++ b/docs/src/sdk/platform.rst
@ -1,6 +1,6 @@
-.. _sdk:
+.. _sdk_platform:

-Supported platforms
+Supported Platforms
 ====================

 SDK is built on CMake and can be used cross multiple platforms such as "Linux, Windows, etc. We provides two installation: Download and install, and Compile and install from source code.
--- a/docs/src/slam/contents.rst
+++ b/docs/src/slam/contents.rst
@ -0,0 +1,11 @@
+OPEN SOURCE 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 @@
 .. _maplab:

-How to use in `Maplab <https://github.com/ethz-asl/maplab>`_ x
+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,6 +1,6 @@
 .. _okvis:

-How to use in `OKVIS <https://github.com/ethz-asl/okvis>`_
+How To Use In `OKVIS <https://github.com/ethz-asl/okvis>`_
 =============================================================

 If you wanna run OKVIS with MYNT EYE camera, please follow the steps:
--- a/docs/src/slam/orb_slam2.rst
+++ b/docs/src/slam/orb_slam2.rst
@ -1,6 +1,6 @@
 .. _orb_slam2:

-How to use in `ORB_SLAM2 <https://github.com/raulmur/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,6 +1,6 @@
 .. _vins:

-How to use in `VINS-Mono <https://github.com/HKUST-Aerial-Robotics/VINS-Mono>`_
+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,6 +1,6 @@
 .. _vins_fusion:

-How to use in `VINS-Fusion <https://github.com/HKUST-Aerial-Robotics/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,6 +1,6 @@
 .. _viorb:

-How to use in `VIORB <https://github.com/jingpang/LearnVIORB>`_
+How To Use In `VIORB <https://github.com/jingpang/LearnVIORB>`_
 ================================================================


--- a/docs/src/support/contact.rst
+++ b/docs/src/support/contact.rst
@ -0,0 +1,6 @@
+Contact Us
+==================
+
+If you continue to encounter problems, please contact customer service. 
+
+http://support.myntai.com/hc/request/new/
--- a/docs/src/support/contents.rst
+++ b/docs/src/support/contents.rst
@ -0,0 +1,10 @@
+TECHNICAL SUPPORT
+==================
+
+.. toctree::
+   :maxdepth: 2
+
+.. toctree::
+
+   problem
+   contact
--- a/docs/src/support/problem.rst
+++ b/docs/src/support/problem.rst
@ -0,0 +1,6 @@
+FAQ
+==================
+
+If you have problems using MYNT EYE, please first check the following docs：
+
+http://support.myntai.com/hc/