Начало Каталог Помощ
Вход
RT-Thread
/
rt-thread
огледало от https://github-proxy.rt-thread.io/RT-Thread/rt-thread.git
2
0
Разклонения 0
Файлове Задачи 0 Уики
ИН на ревизия: 599cefe834
Клонове Маркери
rt-thread
/
documentation
Chen Wang 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
..
0.doxygen 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
1.introduction 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
2.quick-start 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
3.kernel 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
4.tool 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
5.device 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
6.components 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
7.contribution 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
at 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
basic 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
contribution_guide 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
device 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
dlmodule 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
env 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
figures 7692eb18b9 update README.md studio.gif, README_zh.md studiozh.gif (#5875) преди 3 години
filesystem 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
finsh 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
interrupt 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
kernel-porting 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
memory 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
network 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
pm 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
posix 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
sal 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
scons 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
thread 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
thread-comm 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
thread-sync 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
timer 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
ulog 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
utest 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
Doxyfile 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
INDEX.md 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
README.md 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година
run.sh 40f3b6a569 doxygen: create framework to unify markdown and source code part (#9946) преди 1 година

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

A bash script run.sh is provided to automatic upon operations.

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