doxygen: create framework to unify markdown and source code part #9946
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- 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]>
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]>
Signed-off-by: Chen Wang <[email protected]>
|
rt-thread/.github/workflows/doxygen.yml Lines 52 to 55 in 7432b0a |
supperthomas
approved these changes
Jan 23, 2025
10 tasks
Rbb666
approved these changes
Jan 26, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixed #9880
由于改动文件较多，为了方便 review，本 PR 的提交被分割为 11 个 commit。请按照顺序，从 f03b745 -> 6abbe9c review。最终 merge 时可以 squash。
具体每个 commit 的修改内容，请参考每个 commit 的 commit message 部分。页面上点击 ”...“ 部分即可展开。
如果要查看最终的效果，可以参考修改后的
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)
]
当前拉取/合并请求的状态 Intent for your PR
必须选择一项 Choose one (Mandatory):
代码质量 Code Quality：
我在这个拉取/合并请求中已经考虑了 As part of this pull request, I've considered the following:
#if 0代码，不包含已经被注释了的代码 All redundant code is removed and cleaned up