rt-thread-official/INDEX.md at b3bf4c6c3b43ce0b53ede15742bcef989fe1e29d

mirror of https://github.com/RT-Thread/rt-thread.git synced 2025-03-04 13:36:01 +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

305 B

Raw Blame History

@page device Device

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

305 B Raw Blame History

305 B

Raw Blame History