14 Star 2 Fork 14

qpy-doc-center/API_reference

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
该仓库未声明开源许可证文件(LICENSE),使用请关注具体项目描述及其代码上游依赖。
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README

QuecPython API 参考手册编写注意事项

编写规范

参考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目录中:

  • README.md中的图片存放于media根目录。
  • 其余文件中的图片请存放于media下的对应目录中。
  • 图片统一为png格式,命名请见名知意,如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

README.md作为板块的首页入口,需要对该板块做综合性描述,并且在最后提供板块的所有二级目录链接。

QuecPython API 参考手册

点此查看

空文件

简介

取消

发行版

暂无发行版

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/qpy-doc-center/api_reference.git
git@gitee.com:qpy-doc-center/api_reference.git
qpy-doc-center
api_reference
API_reference
master

搜索帮助