rt-thread-official/INDEX.md at 6481633ec641620dcf98e0f3255cfc8f61fd818d

mirror of https://github.com/RT-Thread/rt-thread.git synced 2025-02-25 06:07:05 +08:00

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