rt-thread

mirror of https://github.com/RT-Thread/rt-thread.git synced 2026-10-02 14:23:19 +08:00

Author	SHA1	Message	Date
Chen Wang	e2224f525b	doxygen: update naming rule for utest-case More details see PR #10681. As utest cases are currently moving out of `examples/utest/testcases` into their own module directories, the naming rule needs to change accordingly. Signed-off-by: Chen Wang <unicorn_wang@outlook.com>	2025-09-15 19:40:31 +08:00
Chen Wang	98cb15a3ef	doxygen: add howto for utest RT-Thread BSP Static Build Check / 🔍 Summary of Git Diff Changes (push) Has been cancelled RT-Thread BSP Static Build Check / ${{ matrix.legs.RTT_BSP }} (push) Has been cancelled RT-Thread BSP Static Build Check / collect-artifacts (push) Has been cancelled doc_doxygen / doxygen_doc generate (push) Has been cancelled doc_doxygen / deploy (push) Has been cancelled After "utest: re-org utest framework (initial version)" (PR #10534) was merged, adding a document to introduce how to add utest-cases for your module. Signed-off-by: Chen Wang <unicorn_wang@outlook.com>	2025-08-26 11:06:02 +08:00
Chen Wang	2aebe694d9	doxygen: group name all in lowcase (part 2) (#10530 ) * doxygen: fs: unify groupname to lowercase Signed-off-by: Chen Wang <unicorn_wang@outlook.com> * doxygen: drivers: unify groupname to lowercase Signed-off-by: Chen Wang <unicorn_wang@outlook.com> * doxygen: signal: unify groupname to lowercase Signed-off-by: Chen Wang <unicorn_wang@outlook.com> --------- Signed-off-by: Chen Wang <unicorn_wang@outlook.com>	2025-07-22 13:59:25 +08:00
GuEe-GUI	ad2de6e477	[TOOLS] Add DTC (Devicetree Compiler) tools Signed-off-by: GuEe-GUI <2991707448@qq.com>	2025-06-30 09:42:39 +08:00
Chen Wang	52acf7a413	doxygen: move device_driver under to components for pages pkgs_test / change (push) Has been skipped ToolsCI / Tools (push) Has been cancelled AutoTestCI / components/cpp11 (push) Has been cancelled AutoTestCI / kernel/atomic (push) Has been cancelled AutoTestCI / kernel/atomic/riscv64 (push) Has been cancelled AutoTestCI / kernel/atomic_c11 (push) Has been cancelled AutoTestCI / kernel/atomic_c11/riscv64 (push) Has been cancelled AutoTestCI / kernel/device (push) Has been cancelled AutoTestCI / kernel/ipc (push) Has been cancelled AutoTestCI / kernel/irq (push) Has been cancelled AutoTestCI / kernel/mem (push) Has been cancelled AutoTestCI / kernel/mem/riscv64 (push) Has been cancelled AutoTestCI / kernel/thread (push) Has been cancelled AutoTestCI / kernel/timer (push) Has been cancelled AutoTestCI / rtsmart/aarch64 (push) Has been cancelled AutoTestCI / rtsmart/arm (push) Has been cancelled AutoTestCI / rtsmart/riscv64 (push) Has been cancelled AutoTestCI / components/utest (push) Has been cancelled RT-Thread BSP Static Build Check / 🔍 Summary of Git Diff Changes (push) Has been cancelled RT-Thread BSP Static Build Check / ${{ matrix.legs.RTT_BSP }} (push) Has been cancelled RT-Thread BSP Static Build Check / collect-artifacts (push) Has been cancelled utest_auto_run / AARCH64-rtsmart :default.cfg (push) Has been cancelled utest_auto_run / A9-rtsmart :default.cfg (push) Has been cancelled utest_auto_run / RISCV-rtsmart :default.cfg (push) Has been cancelled utest_auto_run / AARCH64 :default.cfg (push) Has been cancelled utest_auto_run / A9 :default.cfg (push) Has been cancelled utest_auto_run / A9-smp :default.cfg (push) Has been cancelled utest_auto_run / RISCV :default.cfg (push) Has been cancelled doc_doxygen / doxygen_doc generate (push) Has been cancelled doc_doxygen / deploy (push) Has been cancelled In line with the layout of the source code, the Device-Driver submodule should belong to components. The doxygen Module part has been adjusted. This commit modifies the markdown document part and moves the device-driver pages under to components. Signed-off-by: Chen Wang <unicorn_wang@outlook.com>	2025-05-29 13:47:46 +08:00
Chen Wang	75722c4998	doxygen: reorganize directory structure ToolsCI / Tools (push) Waiting to run AutoTestCI / components/cpp11 (push) Waiting to run AutoTestCI / kernel/atomic (push) Waiting to run AutoTestCI / kernel/atomic/riscv64 (push) Waiting to run AutoTestCI / kernel/atomic_c11 (push) Waiting to run AutoTestCI / kernel/atomic_c11/riscv64 (push) Waiting to run AutoTestCI / kernel/device (push) Waiting to run AutoTestCI / kernel/ipc (push) Waiting to run AutoTestCI / kernel/irq (push) Waiting to run AutoTestCI / kernel/mem (push) Waiting to run AutoTestCI / kernel/mem/riscv64 (push) Waiting to run AutoTestCI / kernel/thread (push) Waiting to run AutoTestCI / kernel/timer (push) Waiting to run AutoTestCI / rtsmart/aarch64 (push) Waiting to run AutoTestCI / rtsmart/arm (push) Waiting to run AutoTestCI / rtsmart/riscv64 (push) Waiting to run AutoTestCI / components/utest (push) Waiting to run RT-Thread BSP Static Build Check / ESP32C3 (push) Waiting to run RT-Thread BSP Static Build Check / Infineon_TI_microchip (push) Waiting to run RT-Thread BSP Static Build Check / RT-Thread Online Packages (STM32F407 RT-Spark) (push) Waiting to run RT-Thread BSP Static Build Check / RTduino/Arduino Libraries (Raspberry Pico) (push) Waiting to run RT-Thread BSP Static Build Check / RTduino/Arduino Libraries (STM32F412 Nucleo) (push) Waiting to run RT-Thread BSP Static Build Check / aarch64 (push) Waiting to run RT-Thread BSP Static Build Check / gd32_n32_apm32 (push) Waiting to run RT-Thread BSP Static Build Check / hpmicro (push) Waiting to run RT-Thread BSP Static Build Check / i386-unknown (push) Waiting to run RT-Thread BSP Static Build Check / llvm-arm (push) Waiting to run RT-Thread BSP Static Build Check / mips (push) Waiting to run RT-Thread BSP Static Build Check / nordic(yml) (push) Waiting to run RT-Thread BSP Static Build Check / nuvoton (push) Waiting to run RT-Thread BSP Static Build Check / nxp_renesas (push) Waiting to run RT-Thread BSP Static Build Check / others_at32_hc32_ht32 (push) Waiting to run RT-Thread BSP Static Build Check / riscv-none (push) Waiting to run RT-Thread BSP Static Build Check / riscv64-unknown (push) Waiting to run RT-Thread BSP Static Build Check / simulator (push) Waiting to run RT-Thread BSP Static Build Check / stm32_f2_f4 (push) Waiting to run RT-Thread BSP Static Build Check / stm32_f7_g0_h7_mp15_u5_h5_wb5 (push) Waiting to run RT-Thread BSP Static Build Check / stm32l4_f0_f1 (push) Waiting to run BSP compilation with more drivers / BSP Compilation with More Drivers (push) Waiting to run pkgs_test / change (push) Has been skipped doc_doxygen / doxygen_doc generate (push) Has been cancelled doc_doxygen / deploy (push) Has been cancelled The original directory structure was too flat and inconvenient to view. The directory is now reorganized according to the first-level chapters, and some sub-chapters are moved to the second-level directory. Note: documentation/env is not moved to documentation/4.tool because there are too many external places that reference this path, especially in bsp, so this directory path remains as it is. Signed-off-by: Chen Wang <unicorn_wang@outlook.com>	2025-02-25 11:27:58 +08:00
Chen Wang	f6f7d91a61	doxygen: add prefix for page name (#9989 ) doc_doxygen / doxygen_doc generate (push) Has been cancelled doc_doxygen / deploy (push) Has been cancelled Add prefix "page_" to the name of pages. Add this as a rule in guide of writing doxygen documents. Signed-off-by: Chen Wang <unicorn_wang@outlook.com>	2025-02-13 23:28:19 +08:00
Chen WangandSupper Thomas	40f3b6a569	doxygen: create framework to unify markdown and source code part (#9946 ) ToolsCI / Tools (push) Waiting to run AutoTestCI / components/cpp11 (push) Waiting to run AutoTestCI / kernel/atomic (push) Waiting to run AutoTestCI / kernel/atomic/riscv64 (push) Waiting to run AutoTestCI / kernel/atomic_c11 (push) Waiting to run AutoTestCI / kernel/atomic_c11/riscv64 (push) Waiting to run AutoTestCI / kernel/device (push) Waiting to run AutoTestCI / kernel/ipc (push) Waiting to run AutoTestCI / kernel/irq (push) Waiting to run AutoTestCI / kernel/mem (push) Waiting to run AutoTestCI / kernel/mem/riscv64 (push) Waiting to run AutoTestCI / kernel/thread (push) Waiting to run AutoTestCI / kernel/timer (push) Waiting to run AutoTestCI / rtsmart/aarch64 (push) Waiting to run AutoTestCI / rtsmart/arm (push) Waiting to run AutoTestCI / rtsmart/riscv64 (push) Waiting to run AutoTestCI / components/utest (push) Waiting to run RT-Thread BSP Static Build Check / ESP32C3 (push) Waiting to run RT-Thread BSP Static Build Check / Infineon_TI_microchip (push) Waiting to run RT-Thread BSP Static Build Check / RT-Thread Online Packages (STM32F407 RT-Spark) (push) Waiting to run RT-Thread BSP Static Build Check / RTduino/Arduino Libraries (Raspberry Pico) (push) Waiting to run RT-Thread BSP Static Build Check / RTduino/Arduino Libraries (STM32F412 Nucleo) (push) Waiting to run RT-Thread BSP Static Build Check / aarch64 (push) Waiting to run RT-Thread BSP Static Build Check / gd32_n32_apm32 (push) Waiting to run RT-Thread BSP Static Build Check / hpmicro (push) Waiting to run RT-Thread BSP Static Build Check / i386-unknown (push) Waiting to run RT-Thread BSP Static Build Check / llvm-arm (push) Waiting to run RT-Thread BSP Static Build Check / mips (push) Waiting to run RT-Thread BSP Static Build Check / nordic(yml) (push) Waiting to run RT-Thread BSP Static Build Check / nuvoton (push) Waiting to run RT-Thread BSP Static Build Check / nxp_renesas (push) Waiting to run RT-Thread BSP Static Build Check / others_at32_hc32_ht32 (push) Waiting to run RT-Thread BSP Static Build Check / riscv-none (push) Waiting to run RT-Thread BSP Static Build Check / riscv64-unknown (push) Waiting to run RT-Thread BSP Static Build Check / simulator (push) Waiting to run RT-Thread BSP Static Build Check / stm32_f2_f4 (push) Waiting to run RT-Thread BSP Static Build Check / stm32_f7_g0_h7_mp15_u5_h5_wb5 (push) Waiting to run RT-Thread BSP Static Build Check / stm32l4_f0_f1 (push) Waiting to run BSP compilation with more drivers / BSP Compilation with More Drivers (push) Waiting to run pkgs_test / change (push) Waiting to run doc_doxygen / doxygen_doc generate (push) Has been cancelled doc_doxygen / deploy (push) Has been cancelled * 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