Skip to content

Commit 9652aa9

Browse files
committed
doxygen: add run script
Add a script to automatic some operations. Updated the README.md. Signed-off-by: Chen Wang <[email protected]>
1 parent fa2ccf5 commit 9652aa9

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

documentation/README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ $ sudo apt install graphviz
3030
Assume that the path of RT-Thead code tree is $RTT, execute the following command to build html.
3131

3232
```shell
33-
$ cd $RTT/documentation/doxygen
33+
$ cd $RTT/documentation
3434
$ rm -rf html
3535
$ doxygen
3636
```
@@ -45,4 +45,11 @@ $ python3 -m http.server
4545
Serving HTTP on 0.0.0.0 port 8000 (http://0.0.0.0:8000/) ...
4646
```
4747

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.
48+
A bash script `run.sh` is provided to automatic upon operations.
49+
50+
```shell
51+
$ cd $RTT/documentation
52+
$ ./run.sh
53+
```
54+
55+
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.

documentation/run.sh

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
#!/bin/bash
2+
3+
rm -rf ./html
4+
5+
doxygen
6+
7+
pushd html
8+
python3 -m http.server

0 commit comments

Comments
 (0)