4
0
mirror of https://github.com/RT-Thread/rt-thread.git synced 2025-02-16 12:09:19 +08:00

10 Commits

Author SHA1 Message Date
Chen Wang
40f3b6a569
doxygen: create framework to unify markdown and source code part (#9946)
* doxygen: adjust documentation directory structure

- 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.

* doxygen: update configurations

These configurations are from old documentation/doxygen/Doxyfile.
Try best to compatible exixting design.

* doxygen: add run script

Add a script to automatic some operations.

Updated the README.md.

---------

Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
Co-authored-by: Supper Thomas <78900636@qq.com>
2025-01-26 11:44:39 +08:00
Supper Thomas
f76b97e0c1
[doc] doxygen attach github pages (#9859)
* [doc] doxygen attach github pages

* Update doxygen.yml

* Update doxygen.yml

* Update doxygen.yml

* Update doxygen.yml
2025-01-03 12:09:40 +08:00
Supper Thomas
5b75e1c8bf doc(doxyge):fix doxygen path 2024-12-09 17:12:59 -05:00
Supper Thomas
6320f184f5
[doxygen] add driver example for doxygen (#9446) 2024-09-15 08:22:44 +08:00
supperthomas
038ff8b2e5 [doc][doxygen]: Fix doxygen warning in comment
kservice.c:474: warning: The following parameter of rt_backtrace_to_buffer(rt_thread_t thread, struct rt_hw_backtrace_frame *frame, long skip, rt_ubase_t *buffer, long buflen) is not documented:
  parameter 'thread'
kernel.h:157: warning: unable to resolve reference to '_rt_errno' for \ref command

Signed-off-by: supperthomas <78900636@qq.com>
2024-06-26 01:21:57 +08:00
Meco Man
a0e5526a55 [ci] fix doxygen ci grammar error 2024-04-25 10:13:13 +08:00
Meco Man
57d157b8ab [ci] disable doxygen check 2024-04-20 00:57:17 -04:00
Meco Man
7bc4f7d6a3
[ci] workflow only is used for rt-thread org (#8450) 2023-12-30 15:50:04 +08:00
Meco Man
32ada5eed1 [ci] actions/checkout upgrade to v4 2023-12-27 12:49:19 +08:00
Supper Thomas
65623777d5
[action] Doxygen ci fix (#8191) 2023-10-29 13:12:29 -04:00