代码拉取完成,页面将自动刷新
参考Quectel_QuecPython_WiKi编写规范.pdf。
API 参考手册根目录下存在一个名为README.md
的文件,该文件用来描述 QuecPython 的简介和 API 三个板块的的入口链接。
文档中心使用的teedoc架构要求每个版块的首页文件都要是名为
README.md
的文件。
参照原官网的三个主要板块,将 API 参考手册的目录结构整体划分为 QuecPython 标准库、QuecPython类库 和 QuecPython组件库。
每个目录结构下,均有对应的同名md文件,这些md文件分别对相应的板块做了综合叙述,并列出了板块中包含了哪些模块,点击这些模块名,就可以跳转到对应的模块的md文件中。
同时,每个目录下,也包含了一系列名为<modname>.md
的文件,用来描述名为<modname>
的模块的API;若模块下包含类,则在该目录下创建名为<modname>.<classname>.md
。以machine
模块为例,在QuecPython类库
目录下应创建machine.md
文件,其下存在Pin
等类,需要创建machime.Pin.md
文件。
所有md文件中引用的图片,均存放于media目录中:
machine.Pin.xxx.png
,其中xxx
表示用简短英文编写的图片作用描述。目录结构示例如下:
QuecPython官网文档中心/API手册
├── README.md
├── QuecPython标准库
│ ├── README.md
│ ├── gc.md
│ ├── ubinascii.md
│ ├── ucollections.md
│ ├── uos.md
│ └── urandom.md
├── QuecPython类库
│ ├── README.md
│ ├── atcmd.md
│ ├── cellLocator.md
│ ├── dataCall.md
│ ├── example.md
│ ├── machine.Pin.md
│ ├── machine.md
│ └── wifilocator.md
├── QuecPython组件库
│ ├── README.md
│ ├── TenCentYun.md
│ ├── aLiYun.md
│ ├── log.md
│ ├── request.md
│ └── umqtt.md
└── media
├── QuecPython架构.png
├── QuecPython标准库
│ └── uos.xxx.png
├── QuecPython类库
│ ├── machine.xxx.png
│ └── machine.Pin.xxx.png
└── QuecPython组件库
└── umqtt.xxx.png
README.md作为板块的首页入口,需要对该板块做综合性描述,并且在最后提供板块的所有二级目录链接。
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。