Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doxygen: create framework to unify markdown and source code part #9946

Merged
merged 12 commits into from
Jan 26, 2025

Conversation

unicornx
Copy link
Contributor

@unicornx unicornx commented Jan 23, 2025

Fixed #9880

由于改动文件较多,为了方便 review,本 PR 的提交被分割为 11 个 commit。请按照顺序,从 f03b745 -> 6abbe9c review。最终 merge 时可以 squash。

具体每个 commit 的修改内容,请参考每个 commit 的 commit message 部分。页面上点击 ”...“ 部分即可展开。

image

如果要查看最终的效果,可以参考修改后的 documentation/README.md 中 ubuntu 的环境编译方式,在本地查看修改效果。

基本上就是将 https://www.rt-thread.io/document/site/https://rt-thread.github.io/rt-thread/ 两个网页的内容集成在一起了。

这个 PR 合入后,需要修改 github 的 io 部分,以便 https://rt-thread.github.io/rt-thread/ 可以与代码同步并展现全部内容。

拉取/合并请求描述:(PR description)

[

为什么提交这份PR (why to submit this PR)

你的解决方案是什么 (what is your solution)

请提供验证的bsp和config (provide the config and bsp)

  • BSP:
  • .config:
  • action:

]

当前拉取/合并请求的状态 Intent for your PR

必须选择一项 Choose one (Mandatory):

  • 本拉取/合并请求是一个草稿版本 This PR is for a code-review and is intended to get feedback
  • 本拉取/合并请求是一个成熟版本 This PR is mature, and ready to be integrated into the repo

代码质量 Code Quality:

我在这个拉取/合并请求中已经考虑了 As part of this pull request, I've considered the following:

  • 已经仔细查看过代码改动的对比 Already check the difference between PR and old code
  • 代码风格正确,包括缩进空格,命名及其他风格 Style guide is adhered to, including spacing, naming and other styles
  • 没有垃圾代码,代码尽量精简,不包含#if 0代码,不包含已经被注释了的代码 All redundant code is removed and cleaned up
  • 所有变更均有原因及合理的,并且不会影响到其他软件组件代码或BSP All modifications are justified and not affect other components or BSP
  • 对难懂代码均提供对应的注释 I've commented appropriately where code is tricky
  • 代码是高质量的 Code in this PR is of high quality
  • 已经使用formatting 等源码格式化工具确保格式符合RT-Thread代码规范 This PR complies with RT-Thread code specification
  • 如果是新增bsp, 已经添加ci检查到.github/workflows/bsp_buildings.yml 详细请参考链接BSP自查

- Rename documentation/doxygen to documentation/0.doxygen and cleanup
  some unused files.

- Add/rename folders for each sub sections, such as
  1.introduction/...... Each sub section will be created as a subpage.

- Generate initial Doxyfile, this Doxyfile will be used to unify
  doxygen generated API documents and those markdown files under
  documentation folder. This patch just add the default Doxyfile
  generated by running "doxygen -g". It is used as baseline to add
  more features/configurations.

- Rename documentation/README.md to documentation/INDEX.md, and
  use it as mainpage.

- Move 0.doxygen/readme.md to documentation/README.md.

Signed-off-by: Chen Wang <[email protected]>
These configurations are from old documentation/doxygen/Doxyfile.
Try best to compatible exixting design.

Signed-off-by: Chen Wang <[email protected]>
Add a script to automatic some operations.

Updated the README.md.

Signed-off-by: Chen Wang <[email protected]>
Signed-off-by: Chen Wang <[email protected]>
Signed-off-by: Chen Wang <[email protected]>
Signed-off-by: Chen Wang <[email protected]>
@github-actions github-actions bot added the Doc This PR/issue related with documents label Jan 23, 2025
@supperthomas
Copy link
Member

image
这里路径改下,可以看到效果。

run: |
cd documentation/doxygen
doxygen Doxyfile
cat Doxyfile

@github-actions github-actions bot added the action github action yml imporve label Jan 23, 2025
@Rbb666 Rbb666 merged commit 40f3b6a into RT-Thread:master Jan 26, 2025
48 of 49 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
action github action yml imporve Doc This PR/issue related with documents
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature] 初始的统一 doxgen 框架
3 participants