Domů Procházet Nápověda
Přihlásit se
lqb
/
rt-thread
zrcadlo https://gitee.com/rtthread/rt-thread.git
1
0
Rozštěpit 0
Soubory Úkoly 0 Wiki
Strom: 4343d32df4
Větve Značky
rt-thread
/
documentation
/
doxygen
Rbb666 1284d40ea5 [doc]Update doxygen rtthread_logo.png (#9861) před 10 měsíci
..
images 1284d40ea5 [doc]Update doxygen rtthread_logo.png (#9861) před 10 měsíci
.gitignore 9fbf63441e [doxygen] Fix some warnings in doxygen (#6899) před 2 roky
Doxyfile 6320f184f5 [doxygen] add driver example for doxygen (#9446) před 1 rokem
basicdef.h 72782e9203 convert end of line před 13 roky
filesystem.h 9fbf63441e [doxygen] Fix some warnings in doxygen (#6899) před 2 roky
finsh.h 72782e9203 convert end of line před 13 roky
hardware.h c6a2f5b7bd rt_hw_cpu_shutdown: implement default weak function před 2 roky
kernel.h 14e4c45408 [doc][doxygen] Fix doxygen struct error. před 1 rokem
mainpage.h f34ef8d984 change the version number in the doxygen document před 12 roky
module.h 72782e9203 convert end of line před 13 roky
readme.md f31a87926e doc: introduce how to build & run doxygen on ubuntu před 10 měsíci
systeminit.h 2c98ce4605 [HUST CSE][document] Fix some comments, invalid grouping commands and warnings in Doxygen. před 2 roky
thread.h 2c98ce4605 [HUST CSE][document] Fix some comments, invalid grouping commands and warnings in Doxygen. před 2 roky

readme.md

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：

$ 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:

$ 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.

$ cd $RTT/documentation/doxygen
$ 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.

$ 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.