Startseite Erkunden Hilfe
Anmelden
RT-Thread
/
rt-thread
Mirror von https://github-proxy.rt-thread.io/RT-Thread/rt-thread.git
2
0
Fork 0
Dateien Issues 0 Wiki
Struktur: 599cefe834
Branches Tags
rt-thread
/
documentation
Chen Wang 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
..
0.doxygen 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
1.introduction 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
2.quick-start 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
3.kernel 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
4.tool 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
5.device 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
6.components 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
7.contribution 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
at 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
basic 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
contribution_guide 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
device 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
dlmodule 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
env 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
figures 7692eb18b9 update README.md studio.gif, README_zh.md studiozh.gif (#5875) vor 3 Jahren
filesystem 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
finsh 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
interrupt 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
kernel-porting 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
memory 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
network 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
pm 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
posix 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
sal 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
scons 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
thread 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
thread-comm 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
thread-sync 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
timer 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
ulog 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
utest 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
Doxyfile 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
INDEX.md 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
README.md 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr
run.sh 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) vor 1 Jahr

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.