mirror of
https://gitee.com/mirrors_PX4/PX4-Autopilot.git
synced 2026-10-17 04:03:33 +08:00
Move PX4 Guide source into /docs (#24490)
* Add vitepress tree * Update existing workflows so they dont trigger on changes in the docs path * Add nojekyll, package.json, LICENCE etc * Add crowdin docs upload/download scripts * Add docs flaw checker workflows * Used docs prefix for docs workflows * Crowdin obvious fixes * ci: docs move to self hosted runner runs on a beefy server for faster builds Signed-off-by: Ramon Roche <mrpollo@gmail.com> * ci: don't run build action for docs or ci changes Signed-off-by: Ramon Roche <mrpollo@gmail.com> * ci: update runners Signed-off-by: Ramon Roche <mrpollo@gmail.com> * Add docs/en * Add docs assets and scripts * Fix up editlinks to point to PX4 sources * Download just the translations that are supported * Add translation sources for zh, uk, ko * Update latest tranlsation and uorb graphs * update vitepress to latest --------- Signed-off-by: Ramon Roche <mrpollo@gmail.com> Co-authored-by: Ramon Roche <mrpollo@gmail.com>
This commit is contained in:
co-authored by
Ramon Roche
parent
8e6d2ebe4a
commit
88d623bedb
@@ -0,0 +1,62 @@
|
||||
# 模块参考: 模板
|
||||
|
||||
## 模块
|
||||
|
||||
Source: [templates/template_module](https://github.com/PX4/PX4-Autopilot/tree/main/src/templates/template_module)
|
||||
|
||||
### 描述
|
||||
|
||||
该部分描述所提供模块的功能。
|
||||
|
||||
这是一个模块的模版,该模块在后台作为任务(task)运行并且有 start/stop/status 功能。
|
||||
|
||||
### 实现
|
||||
|
||||
该部分描述模块的高层次实现。
|
||||
|
||||
### 示例
|
||||
|
||||
CLI usage example:
|
||||
|
||||
```
|
||||
module start -f -p 42
|
||||
```
|
||||
|
||||
<a id="module_usage"></a>
|
||||
|
||||
### 用法
|
||||
|
||||
```
|
||||
module <command> [arguments...]
|
||||
Commands:
|
||||
start
|
||||
[-f] Optional example flag
|
||||
[-p <val>] Optional example parameter
|
||||
default: 0
|
||||
|
||||
stop
|
||||
|
||||
status print status info
|
||||
```
|
||||
|
||||
## work_item_example
|
||||
|
||||
Source: [examples/work_item](https://github.com/PX4/PX4-Autopilot/tree/main/src/examples/work_item)
|
||||
|
||||
### 描述
|
||||
|
||||
Example of a simple module running out of a work queue.
|
||||
|
||||
<a id="work_item_example_usage"></a>
|
||||
|
||||
### 用法
|
||||
|
||||
```
|
||||
work_item_example <command> [arguments...]
|
||||
Commands:
|
||||
start
|
||||
|
||||
stop
|
||||
|
||||
status print status info
|
||||
```
|
||||
Reference in New Issue
Block a user