Эхлэл Бүгдийг харах Тусламж
Нэвтрэх
RT-Thread
/
rt-thread
-ын хуулбар https://github-proxy.rt-thread.io/RT-Thread/rt-thread.git
2
0
Салаа 0
Файлууд Асуудлууд 0 Мэдлэгийн сан
Мод: 2fdb9381bb
Салаанууд Тагууд
rt-thread
/
documentation
wumingzi 6481633ec6 [doxygen] add doxygen comment for clk.c and clk.h (#9950) 1 жил өмнө
..
0.doxygen 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
1.introduction 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
2.quick-start 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
3.kernel 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
4.tool 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
5.device 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
6.components 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
7.contribution 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
at 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
basic 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
contribution_guide 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
device 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
dlmodule 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
env 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
figures 7692eb18b9 update README.md studio.gif, README_zh.md studiozh.gif (#5875) 3 жил өмнө
filesystem 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
finsh 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
interrupt 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
kernel-porting 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
memory 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
network 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
pm 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
posix 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
sal 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
scons 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
thread 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
thread-comm 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
thread-sync 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
timer 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
ulog 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
utest 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
Doxyfile 6481633ec6 [doxygen] add doxygen comment for clk.c and clk.h (#9950) 1 жил өмнө
INDEX.md 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
README.md 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө
run.sh 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 жил өмнө

README.md

How to build doxygen html

  1. download from https://doxygen.nl/index.html
  2. open Doxywizard
  3. File -> Open
  4. Open the file ./Doxyfile
  5. To tab Run , Click Run doxygen

How to build & run doxygen html on Ubuntu

The following steps are verified on Ubuntu 22.04：

$ lsb_release -a
No LSB modules are available.
Distributor ID:	Ubuntu
Description:	Ubuntu 22.04.5 LTS
Release:	22.04
Codename:	jammy

The following packages (and dependents) need to be installed:

$ sudo apt update
$ sudo apt install doxygen
$ sudo apt install graphviz

Assume that the path of RT-Thead code tree is $RTT, execute the following command to build html.

$ cd $RTT/documentation
$ rm -rf html
$ doxygen

A new html directory will be created and all the html files will be placed in this directory.

If you want to quickly browse HTML locally (in Ubuntu environment), you can enter the html directory and start a local HTML server through Python.

$ cd html
$ python3 -m http.server
Serving HTTP on 0.0.0.0 port 8000 (http://0.0.0.0:8000/) ...

A bash script run.sh is provided to automatic upon operations.

$ cd $RTT/documentation
$ ./run.sh

Then open the browser and enter http://<IP>:8000/index.html to access the created html web pages. If it is a local access, then <IP> should be replaced by localhost. If it is a remote access, then <IP> should be replaced by the actual accessible IP address of the machine where HTML is located.