rt-thread-official/documentation/run.sh

#!/bin/bash

RTT_PATH=$(realpath $(dirname $0)/..)
RTT_DOC_PATH=$RTT_PATH/documentation

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!"
    echo ""
    exit 1
fi

pushd $RTT_DOC_PATH/html
python3 -m http.server
doxygen: create framework to unify markdown and source code part (#9946) * doxygen: adjust documentation directory structure - Rename documentation/doxygen to documentation/0.doxygen and cleanup some unused files. - Add/rename folders for each sub sections, such as 1.introduction/...... Each sub section will be created as a subpage. - Generate initial Doxyfile, this Doxyfile will be used to unify doxygen generated API documents and those markdown files under documentation folder. This patch just add the default Doxyfile generated by running "doxygen -g". It is used as baseline to add more features/configurations. - Rename documentation/README.md to documentation/INDEX.md, and use it as mainpage. - Move 0.doxygen/readme.md to documentation/README.md. * doxygen: update configurations These configurations are from old documentation/doxygen/Doxyfile. Try best to compatible exixting design. * doxygen: add run script Add a script to automatic some operations. Updated the README.md. --------- Signed-off-by: Chen Wang <unicorn_wang@outlook.com> Co-authored-by: Supper Thomas <78900636@qq.com> 2025-01-26 11:44:39 +08:00			`#!/bin/bash`

doxygen: support running from the root directory 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> 2025-02-21 17:04:02 +08:00			`RTT_PATH=$(realpath $(dirname $0)/..)`
			`RTT_DOC_PATH=$RTT_PATH/documentation`
doxygen: create framework to unify markdown and source code part (#9946) * doxygen: adjust documentation directory structure - Rename documentation/doxygen to documentation/0.doxygen and cleanup some unused files. - Add/rename folders for each sub sections, such as 1.introduction/...... Each sub section will be created as a subpage. - Generate initial Doxyfile, this Doxyfile will be used to unify doxygen generated API documents and those markdown files under documentation folder. This patch just add the default Doxyfile generated by running "doxygen -g". It is used as baseline to add more features/configurations. - Rename documentation/README.md to documentation/INDEX.md, and use it as mainpage. - Move 0.doxygen/readme.md to documentation/README.md. * doxygen: update configurations These configurations are from old documentation/doxygen/Doxyfile. Try best to compatible exixting design. * doxygen: add run script Add a script to automatic some operations. Updated the README.md. --------- Signed-off-by: Chen Wang <unicorn_wang@outlook.com> Co-authored-by: Supper Thomas <78900636@qq.com> 2025-01-26 11:44:39 +08:00
doxygen: support running from the root directory 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> 2025-02-21 17:04:02 +08:00			`rm -rf $RTT_DOC_PATH/html`

			`cd $RTT_DOC_PATH`
			`doxygen ./Doxyfile`
doxygen: More strict checks on build results (#10007) Github CI doc_doxygen is very strict in checking the build results, and will output failure even if there are warnings. In order to match CI's checks, local build scripts are also checked more strictly to detect potential errors and even warnings as early as possible. Signed-off-by: Chen Wang <unicorn_wang@outlook.com> 2025-02-19 21:21:04 +08:00			`if [ $? -ne 0 ]; then`
			`echo ""`
			`echo "OOPS: Something error/warning occurred during Doxygen building, please check it out!"`
			`echo ""`
			`exit 1`
			`fi`
doxygen: create framework to unify markdown and source code part (#9946) * doxygen: adjust documentation directory structure - Rename documentation/doxygen to documentation/0.doxygen and cleanup some unused files. - Add/rename folders for each sub sections, such as 1.introduction/...... Each sub section will be created as a subpage. - Generate initial Doxyfile, this Doxyfile will be used to unify doxygen generated API documents and those markdown files under documentation folder. This patch just add the default Doxyfile generated by running "doxygen -g". It is used as baseline to add more features/configurations. - Rename documentation/README.md to documentation/INDEX.md, and use it as mainpage. - Move 0.doxygen/readme.md to documentation/README.md. * doxygen: update configurations These configurations are from old documentation/doxygen/Doxyfile. Try best to compatible exixting design. * doxygen: add run script Add a script to automatic some operations. Updated the README.md. --------- Signed-off-by: Chen Wang <unicorn_wang@outlook.com> Co-authored-by: Supper Thomas <78900636@qq.com> 2025-01-26 11:44:39 +08:00
doxygen: support running from the root directory 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> 2025-02-21 17:04:02 +08:00			`pushd $RTT_DOC_PATH/html`
doxygen: create framework to unify markdown and source code part (#9946) * doxygen: adjust documentation directory structure - Rename documentation/doxygen to documentation/0.doxygen and cleanup some unused files. - Add/rename folders for each sub sections, such as 1.introduction/...... Each sub section will be created as a subpage. - Generate initial Doxyfile, this Doxyfile will be used to unify doxygen generated API documents and those markdown files under documentation folder. This patch just add the default Doxyfile generated by running "doxygen -g". It is used as baseline to add more features/configurations. - Rename documentation/README.md to documentation/INDEX.md, and use it as mainpage. - Move 0.doxygen/readme.md to documentation/README.md. * doxygen: update configurations These configurations are from old documentation/doxygen/Doxyfile. Try best to compatible exixting design. * doxygen: add run script Add a script to automatic some operations. Updated the README.md. --------- Signed-off-by: Chen Wang <unicorn_wang@outlook.com> Co-authored-by: Supper Thomas <78900636@qq.com> 2025-01-26 11:44:39 +08:00			`python3 -m http.server`