Skip to content

Commit f31a879

Browse files
unicornxmysterywolf
authored andcommitted
doc: introduce how to build & run doxygen on ubuntu
Update readme doc to introduce how to build doxygen and run html on Ubuntu machines. Signed-off-by: Chen Wang <[email protected]>
1 parent 2d78d8c commit f31a879

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

Diff for: documentation/doxygen/readme.md

+40
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,43 @@
66
4. Open the file ./Doxyfile
77
5. To tab `Run` , Click `Run doxygen`
88

9+
# How to build & run doxygen html on Ubuntu
10+
11+
The following steps are verified on Ubuntu 22.04:
12+
13+
```shell
14+
$ lsb_release -a
15+
No LSB modules are available.
16+
Distributor ID: Ubuntu
17+
Description: Ubuntu 22.04.5 LTS
18+
Release: 22.04
19+
Codename: jammy
20+
```
21+
22+
The following packages (and dependents) need to be installed:
23+
24+
```shell
25+
$ sudo apt update
26+
$ sudo apt install doxygen
27+
$ sudo apt install graphviz
28+
```
29+
30+
Assume that the path of RT-Thead code tree is $RTT, execute the following command to build html.
31+
32+
```shell
33+
$ cd $RTT/documentation/doxygen
34+
$ rm -rf html
35+
$ doxygen
36+
```
37+
38+
A new html directory will be created and all the html files will be placed in this directory.
39+
40+
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.
41+
42+
```shell
43+
$ cd html
44+
$ python3 -m http.server
45+
Serving HTTP on 0.0.0.0 port 8000 (http://0.0.0.0:8000/) ...
46+
```
47+
48+
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.

0 commit comments

Comments
 (0)