Skip to content

Commit

Permalink
doc: introduce how to build & run doxygen on ubuntu
Browse files Browse the repository at this point in the history
Update readme doc to introduce how to build doxygen and run html
on Ubuntu machines.

Signed-off-by: Chen Wang <[email protected]>
  • Loading branch information
unicornx committed Dec 23, 2024
1 parent 2d78d8c commit 4c2ba2b
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions documentation/doxygen/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,43 @@
4. Open the file ./Doxyfile

Check failure on line 6 in documentation/doxygen/readme.md

View workflow job for this annotation

GitHub Actions / Check Spelling

`Doxyfile` is not a recognized word. (unrecognized-spelling)
5. To tab `Run` , Click `Run doxygen`

Check failure on line 7 in documentation/doxygen/readme.md

View workflow job for this annotation

GitHub Actions / Check Spelling

`doxygen` is not a recognized word. (unrecognized-spelling)

# How to build & run doxygen html on Ubuntu

Check failure on line 9 in documentation/doxygen/readme.md

View workflow job for this annotation

GitHub Actions / Check Spelling

`doxygen` is not a recognized word. (unrecognized-spelling)

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

Check failure on line 19 in documentation/doxygen/readme.md

View workflow job for this annotation

GitHub Actions / Check Spelling

`Codename` is not a recognized word. (unrecognized-spelling)
```

The following packages (and dependents) need to be installed:

```shell
$ sudo apt update
$ sudo apt install doxygen

Check failure on line 26 in documentation/doxygen/readme.md

View workflow job for this annotation

GitHub Actions / Check Spelling

`doxygen` is not a recognized word. (unrecognized-spelling)
$ sudo apt install graphviz
```

Assume that the path of RT-Thead code tree is $RTT, execute the following command to build html.

Check failure on line 30 in documentation/doxygen/readme.md

View workflow job for this annotation

GitHub Actions / Check Spelling

`Thead` is not a recognized word. (unrecognized-spelling)

```shell
$ cd $RTT/documentation/doxygen
$ rm -rf html
$ doxygen

Check warning on line 35 in documentation/doxygen/readme.md

View workflow job for this annotation

GitHub Actions / Check Spelling

`doxygen` is not a recognized word -- found 7 times. (limited-references)
```

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/) ...
```

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 comments on commit 4c2ba2b

Please sign in to comment.