Domovská stránka Prehľadávať Pomoc
Prihlásiť sa
lqb
/
rt-thread
zrkadlo https://gitee.com/rtthread/rt-thread.git
1
0
Fork 0
Súbory Issues 0 Wiki
Strom: d3d33ff983
Branche Tagy
rt-thread
/
documentation
wumingzi 6481633ec6 [doxygen] add doxygen comment for clk.c and clk.h (#9950) 1 rok pred
..
0.doxygen 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
1.introduction 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
2.quick-start 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
3.kernel 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
4.tool 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
5.device 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
6.components 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
7.contribution 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
at 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
basic 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
contribution_guide 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
device 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
dlmodule 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
env 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
figures 7692eb18b9 update README.md studio.gif, README_zh.md studiozh.gif (#5875) 3 rokov pred
filesystem 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
finsh 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
interrupt 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
kernel-porting 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
memory 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
network 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
pm 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
posix 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
sal 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
scons 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
thread 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
thread-comm 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
thread-sync 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
timer 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
ulog 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
utest 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
Doxyfile 6481633ec6 [doxygen] add doxygen comment for clk.c and clk.h (#9950) 1 rok pred
INDEX.md 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
README.md 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred
run.sh 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 rok pred

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.