Home Esplora Aiuto
Accedi
RT-Thread
/
rt-thread
mirror da https://github-proxy.rt-thread.io/RT-Thread/rt-thread.git
2
0
Forka 0
File Problemi 0 Wiki
Albero (Tree): ffe25c58b9
Rami (Branch) Tag
rt-thread
/
documentation
wumingzi 6481633ec6 [doxygen] add doxygen comment for clk.c and clk.h (#9950) 1 anno fa
..
0.doxygen 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
1.introduction 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
2.quick-start 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
3.kernel 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
4.tool 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
5.device 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
6.components 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
7.contribution 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
at 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
basic 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
contribution_guide 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
device 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
dlmodule 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
env 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
figures 7692eb18b9 update README.md studio.gif, README_zh.md studiozh.gif (#5875) 3 anni fa
filesystem 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
finsh 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
interrupt 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
kernel-porting 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
memory 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
network 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
pm 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
posix 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
sal 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
scons 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
thread 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
thread-comm 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
thread-sync 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
timer 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
ulog 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
utest 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
Doxyfile 6481633ec6 [doxygen] add doxygen comment for clk.c and clk.h (#9950) 1 anno fa
INDEX.md 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
README.md 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa
run.sh 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) 1 anno fa

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.