Toggle navigation
首页
问答
文章
积分商城
专家
专区
更多专区...
文档中心
返回主站
搜索
提问
会员
中心
登录
注册
Doxygen
github
[github pages] 如何在线查看RT-THREAD的API 的注释
发布于 2023-01-18 23:14:47 浏览:960
订阅该版
[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
2
条评论
默认排序
按发布时间排序
登录
注册新账号
关于作者
RTT_逍遥
https://github.com/supperthomas
文章
33
回答
491
被采纳
71
关注TA
发私信
相关文章
1
RT_Thread ENV 下载问题
2
github下载时总是中断失败
3
提高github的响应速度
4
RT-thread ENV 工具配置软件包时总是无法连上git网址,无法下载?
5
软件包下载问题解决经验
6
无法下载littlevgl 软件包
7
软件包无法下载(已解决)
8
RT-Thread studio 如何更换git下载源?
9
【github】大家在用github有哪些问题
10
github登录不了,重置密码也不行
推荐文章
1
RT-Thread应用项目汇总
2
玩转RT-Thread系列教程
3
机器人操作系统 (ROS2) 和 RT-Thread 通信
4
国产MCU移植系列教程汇总,欢迎查看!
5
五分钟玩转RT-Thread新社区
6
【技术三千问】之《玩转ART-Pi》,看这篇就够了!干货汇总
7
关于STM32H7开发板上使用SDIO接口驱动SD卡挂载文件系统的问题总结
8
STM32的“GPU”——DMA2D实例详解
9
RT-Thread隐藏的宝藏之completion
10
【ART-PI】RT-Thread 开启RTC 与 Alarm组件
热门标签
RT-Thread Studio
串口
LWIP
SPI
Env
Bootloader
AT
ART-Pi
Hardfault
CAN总线
FinSH
USB
文件系统
DMA
RT-Thread
SCons
线程
RT-Thread Nano
MQTT
STM32
RTC
FAL
rt-smart
ESP8266
ota在线升级
WIZnet_W5500
I2C_IIC
UART
flash
cubemx
packages_软件包
freemodbus
PWM
潘多拉开发板_Pandora
定时器
ADC
BSP
中断
编译报错
socket
keil_MDK
GD32
MicroPython
msh
Debug
ulog
SDIO总线
SFUD
rt_mq_消息队列_msg_queue
flashDB
本月问答贡献
用户名由3_15位
17
个答案
3
次被采纳
xiaorui
7
个答案
3
次被采纳
sakumisu
4
个答案
3
次被采纳
三世执戟
32
个答案
1
次被采纳
梦笑真美
20
个答案
1
次被采纳
本月文章贡献
比特饼干
2
篇文章
6
次点赞
Z_Y
2
篇文章
5
次点赞
Alipay
2
篇文章
3
次点赞
xusiwei1236
2
篇文章
3
次点赞
yinxiangxv
2
篇文章
3
次点赞
回到
顶部
发布
问题
投诉
建议
回到
底部