libs/rt-thread-official
libs/rt-thread-official
4
0
Fork 0
mirror of https://github.com/RT-Thread/rt-thread.git synced 2025-02-24 11:17:05 +08:00
Code Issues Releases Wiki Activity

doxygen: support running from the root directory

Browse Source 
Previously, you had to enter the documentation directory
before executing the run.sh script, which was not very
convenient during development, especially when you needed
to execute other commands in the source code root directory
at the same time, such as git commands.

Now you can directly run script in the source code root
directory as below:

```shell
$ cd $RTT
$ ./documentation/run.sh
```

No need to switch the working path any more after entering
the source code root directory.

Signed-off-by: Chen Wang <unicorn_wang@outlook.com>
This commit is contained in:
Chen Wang 2025-02-21 17:04:02 +08:00 committed by Meco Man
parent 4e5f95e4f9
commit 9dd309df26
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
documentation/run.sh
View File

@ -1,8 +1,12 @@
#!/bin/bash
rm -rf ./html
RTT_PATH=$(realpath $(dirname $0)/..)
RTT_DOC_PATH=$RTT_PATH/documentation
doxygen
rm -rf $RTT_DOC_PATH/html
cd $RTT_DOC_PATH
doxygen ./Doxyfile
if [ $? -ne 0 ]; then
echo ""
echo "OOPS: Something error/warning occurred during Doxygen building, please check it out!"
@ -10,5 +14,5 @@ if [ $? -ne 0 ]; then
exit 1
fi
pushd html
pushd $RTT_DOC_PATH/html
python3 -m http.server