mirror of
https://github.com/RT-Thread/rt-thread.git
synced 2025-02-25 16:37:06 +08:00
40f3b6a569
* 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>
56 lines
1.5 KiB
Markdown
56 lines
1.5 KiB
Markdown
# 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：
|
||
|
||
```shell
|
||
$ 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:
|
||
|
||
```shell
|
||
$ 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.
|
||
|
||
```shell
|
||
$ 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.
|
||
|
||
```shell
|
||
$ 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.
|
||
|
||
```shell
|
||
$ 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.
|