rt-thread/documentation/INDEX.md at 2dfbae28532303526f6bf4b60a54794c845d444a

Mirrors_Framework/rt-thread

Fork 0

mirror of https://github.com/RT-Thread/rt-thread.git synced 2026-06-22 02:17:32 +08:00

Files

T

Chen Wang 40f3b6a569

ToolsCI / Tools (push) Waiting to run

Details

AutoTestCI / components/cpp11 (push) Waiting to run

Details

AutoTestCI / kernel/atomic (push) Waiting to run

Details

AutoTestCI / kernel/atomic/riscv64 (push) Waiting to run

Details

AutoTestCI / kernel/atomic_c11 (push) Waiting to run

Details

AutoTestCI / kernel/atomic_c11/riscv64 (push) Waiting to run

Details

AutoTestCI / kernel/device (push) Waiting to run

Details

AutoTestCI / kernel/ipc (push) Waiting to run

Details

AutoTestCI / kernel/irq (push) Waiting to run

Details

AutoTestCI / kernel/mem (push) Waiting to run

Details

AutoTestCI / kernel/mem/riscv64 (push) Waiting to run

Details

AutoTestCI / kernel/thread (push) Waiting to run

Details

AutoTestCI / kernel/timer (push) Waiting to run

Details

AutoTestCI / rtsmart/aarch64 (push) Waiting to run

Details

AutoTestCI / rtsmart/arm (push) Waiting to run

Details

AutoTestCI / rtsmart/riscv64 (push) Waiting to run

Details

AutoTestCI / components/utest (push) Waiting to run

Details

RT-Thread BSP Static Build Check / ESP32C3 (push) Waiting to run

Details

RT-Thread BSP Static Build Check / Infineon_TI_microchip (push) Waiting to run

Details

RT-Thread BSP Static Build Check / RT-Thread Online Packages (STM32F407 RT-Spark) (push) Waiting to run

Details

RT-Thread BSP Static Build Check / RTduino/Arduino Libraries (Raspberry Pico) (push) Waiting to run

Details

RT-Thread BSP Static Build Check / RTduino/Arduino Libraries (STM32F412 Nucleo) (push) Waiting to run

Details

RT-Thread BSP Static Build Check / aarch64 (push) Waiting to run

Details

RT-Thread BSP Static Build Check / gd32_n32_apm32 (push) Waiting to run

Details

RT-Thread BSP Static Build Check / hpmicro (push) Waiting to run

Details

RT-Thread BSP Static Build Check / i386-unknown (push) Waiting to run

Details

RT-Thread BSP Static Build Check / llvm-arm (push) Waiting to run

Details

RT-Thread BSP Static Build Check / mips (push) Waiting to run

Details

RT-Thread BSP Static Build Check / nordic(yml) (push) Waiting to run

Details

RT-Thread BSP Static Build Check / nuvoton (push) Waiting to run

Details

RT-Thread BSP Static Build Check / nxp_renesas (push) Waiting to run

Details

RT-Thread BSP Static Build Check / others_at32_hc32_ht32 (push) Waiting to run

Details

RT-Thread BSP Static Build Check / riscv-none (push) Waiting to run

Details

RT-Thread BSP Static Build Check / riscv64-unknown (push) Waiting to run

Details

RT-Thread BSP Static Build Check / simulator (push) Waiting to run

Details

RT-Thread BSP Static Build Check / stm32_f2_f4 (push) Waiting to run

Details

RT-Thread BSP Static Build Check / stm32_f7_g0_h7_mp15_u5_h5_wb5 (push) Waiting to run

Details

RT-Thread BSP Static Build Check / stm32l4_f0_f1 (push) Waiting to run

Details

BSP compilation with more drivers / BSP Compilation with More Drivers (push) Waiting to run

Details

pkgs_test / change (push) Waiting to run

Details

doc_doxygen / doxygen_doc generate (push) Has been cancelled

Details

doc_doxygen / deploy (push) Has been cancelled

Details

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

846 B

Raw Blame History

@mainpage RT-Thread User Guide

@subpage introduction

@subpage quick_start

@subpage kernel

@ref kernel_basics
@ref thread_management
@ref clock_management
@ref thread_sync
@ref thread_comm
@ref memory_management
@ref interrupt_management
@ref kernel_porting

@subpage tool

@ref env
@ref scons

@subpage device

@ref device_framework
@ref device_pin
@ref device_uart
@ref device_adc
@ref device_i2c
@ref device_spi
@ref device_pwm
@ref device_rtc
@ref device_hwtimer
@ref device_watchdog
@ref device_wlan
@ref device_sensor

@subpage components

@ref component_finsh
@ref component_vfs
@ref component_utest
@ref component_dlmodule
@ref component_sal
@ref component_at
@ref component_posix
@ref component_ulog
@ref component_pm
@ref component_network

@subpage code_contribution

846 B Raw Blame History

846 B

Raw Blame History