现成Sphinx实例(基于Dji SDK)

云深无际

发布于 2020-12-07 11:47:26

8050

发布于 2020-12-07 11:47:26

文章被收录于专栏：云深之无迹

这里先从Github上面把大疆EP机器人得开源库完整的clone下来

可以看到到里面有doc的文件夹,打开以后是完整的文档.

我们应该可以编译出文档

就是这样,一个源文件的目录每一个脚本文件一个Makefile文件

打开里面的bat文件,看end::后面加入了一些参数,这里不知道,以后查询

make html 编译网页出来.稍等片刻就出来了

可以看到有了build的目录,而且也有了网页,打开.下面是我主机的地址

file:///C:/Users/yunswj/Desktop/RoboMaster-SDK-master/RoboMaster-SDK-master/docs/build/html/introduction.html#ep

首次打开是这样的

写作得是这样得文件

渲染出来得文档是这样得

渲染得源文件与网页之间得关系

我们这里拿一个有图片的渲染页面看一下这个图片路径的加载

在这里,可以看到语法是这样的:

首先是一个image的这个标签,后面是一个相对路径..(.号是指当前路径是父级点从上方遍历),接着是一个属性align,对齐选择居中.

-- image::./images/tird_part.png
    :align: center

可以看到在文件夹里面确实找到了真实的图片

这段又是一个写作的源码与渲染文档之间的对比

当你的鼠标放置在一个链接上面的时候,浏览器会出现真实的路径

.. image:: images/robomaster.jpg

==================================
 欢迎来到 RoboMaster 开发者页面
==================================

.. toctree::
    :maxdepth: 0
    :caption: 快速开始
    :numbered:

    introduction.rst
    code_env_setup.rst
    third_part_comm.rst

.. toctree::
    :maxdepth: 0
    :caption: RoboMaster SDK 说明
    :numbered:

    python_sdk/installs.rst
    python_sdk/downloads.rst
    python_sdk/connection.rst
    python_sdk/beginner.rst
    python_sdk/beginner_ep.rst
    python_sdk/beginner_drone.rst
    python_sdk/beginner_multi_robot.rst
    python_sdk/log.rst
    python_sdk/apis.rst
    python_sdk/modules.rst
    python_sdk/multi_robot_apis.rst
    python_sdk/multi_robot_drone_example.rst
    python_sdk/multi_robot_ep.rst

.. toctree::
    :maxdepth: 0
    :caption: 拓展模块/拓展接口说明
    :numbered:

    extension_module/robotic_arm_and_gripper.rst
    extension_module/servo.rst
    extension_module/ir_distance_sensor.rst
    extension_module/sensor_adapter.rst
    extension_module/uart.rst


.. toctree::
    :maxdepth: 0
    :caption: 明文 SDK 说明
    :numbered:

    text_sdk/intro.rst
    text_sdk/connection.rst
    text_sdk/apis.rst
    text_sdk/multi_ctrl.rst

.. toctree::
    :maxdepth: 0
    :caption: Python 编程说明
    :numbered:

    python/intro.rst
    python/feature.rst
    python/apis.rst

.. toctree::
    :maxdepth: 0
    :caption: 版本说明

    version.rst


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`