[github pages] 如何在线查看RT-THREAD的API 的注释

发布于 2023-01-18 23:14:47 浏览：1663 订阅该版

[tocm]

## 简介
前文讲解如何用doxygen生成api文档
玩转doxygen之rt-trehad
https://club.rt-thread.org/ask/article/bf867386b24e5d7c.html
感觉小伙伴们都喜欢直接拿来用，
所以这篇文章给大家整理了一个在线的网站，直接显示RT-THREAD doxygen的文档，
给大家直接使用，
这个网址就是
https://supperthomas.github.io/RTT_doxygen_API
这个网址是永久的，而且免费的。方便大家直接查阅API。后续我也会持续根据master上面的注释更新这个API网站（后续会让机器人自动同步）。
## 如何做这个网站
如果直接用的话，用网址就可以了
https://supperthomas.github.io/RTT_doxygen_API
欢迎收藏，或者有问题也可以在评论区留言
关于如何制作，也很简单
### 第一步 将生成的html上传到github
根据
玩转doxygen之rt-trehad
https://club.rt-thread.org/ask/article/bf867386b24e5d7c.html
生成html文件夹
然后把文件夹的内容push到git的仓库里面，可以自己定义仓库名称
参考仓库
https://github.com/supperthomas/RTT_doxygen_API/
欢迎随手点个star
### 第二步 设置github pages
在这个仓库的设置里面
有个pages的页面，里面设置一下路径，这个路径中root代表根目录，这个网址会根据这个根目录下面的index.html来打开对应的页面
里面使能即可，过一段时间再打开这个页面就能看到网址了
如果有域名还可以绑定域名

![screenshot_image.png](https://oss-club.rt-thread.org/uploads/20230118/60455d8c4ec3d75021efe8f99669a9ee.png.webp)

## 总结
当然今天最主要的是给大家提供一个网址可以随时查看RT-THREAD中的代码注释及API
https://supperthomas.github.io/RTT_doxygen_API

当然你想看中文的，可以看这个，也有用 （不过我猜测这个没有和master上进行更新同步，上面那个主要根据master上的最新的生成的）
https://www.rt-thread.org/document/api/index.html