Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ on: [push]
jobs:
build:
name: Deploy docs to GitHub Pages
runs-on: ubuntu-22.04
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2

- uses: actions/setup-python@v6
with:
python-version: '3.8'
python-version: '3.11'

- name: Build API doc
run: |
Expand All @@ -31,15 +31,14 @@ jobs:
echo current directory file:
ls
cp -r _build/html ../../site

- name: Build
uses: OpenHUTB/actions-mkdocs@main
with:
mkdocs_version: 'latest' # option
#mkdocs_version: '1.1' # option
requirements: 'requirements.txt' # option
configfile: 'mkdocs.yml' # option

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ AirSim 的另一种使用方式是所谓的“计算机视觉”模式。在此

更多技术细节请参阅 [AirSim 论文(FSR 2017 会议))](https://arxiv.org/abs/1705.05065) 。请引用:

```
```shell
@inproceedings{airsim2017fsr,
author = {Shital Shah and Debadeepta Dey and Chris Lovett and Ashish Kapoor},
title = {AirSim: High-Fidelity Visual and Physical Simulation for Autonomous Vehicles},
Expand Down
15 changes: 4 additions & 11 deletions docs/dev/Carla_Air.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,26 +161,19 @@ CARLA-Air 与 14 个现有仿真平台的全面对比(基于[技术报告](htt

### 选项 A:使用预编译版本(推荐)

```shell
# 1. 下载并解压 CarlaAir-v0.1.7
```sh
tar xzf CarlaAir-v0.1.7.tar.gz
cd CarlaAir-v0.1.7
```

# 2. 一键环境配置(仅首次需要)
```shell
bash env_setup/setup_env.sh # 创建 conda 环境,安装依赖,部署 carla 模块
conda activate carlaAir
bash env_setup/test_env.sh # 验证环境:应全部显示 PASS
```

# 3. 启动仿真器(自动生成交通流)
```shell
./CarlaAir.sh Town10HD
```

# 4. 运行展示脚本!(另开一个终端)
```shell
conda activate carlaAir
python3 examples/quick_start_showcase.py
```
Expand All @@ -197,7 +190,7 @@ python3 examples/quick_start_showcase.py

两套 API 共享**同一个仿真世界** — 无桥接、无同步烦恼。

```py
```python
import carla, airsim

carla_client = carla.Client("localhost", 2000)
Expand All @@ -215,7 +208,7 @@ air_client.moveToPositionAsync(80, 30, -25, 5)

**6 个演示脚本** — 逐个试试:

```shell
```sh
python3 examples/quick_start_showcase.py # 🎬 4分屏传感器 + 无人机追踪 + 天气轮换
python3 examples/drive_vehicle.py # 🚗 WASD 驾驶特斯拉
python3 examples/walk_pedestrian.py # 🚶 鼠标+键盘 城市漫步
Expand All @@ -226,7 +219,7 @@ python3 examples/air_ground_sync.py # 🔄 车+无人机分屏:同一

**录制工具** — 录制车辆、无人机、行人轨迹,然后用导演相机回放:

```shell
```sh
python3 examples/recording/record_vehicle.py # 🚗 键盘驾驶并录制车辆轨迹
python3 examples/recording/record_drone.py # 🚁 飞行并录制无人机轨迹(零侵入)
python3 examples/recording/record_walker.py # 🚶 行走并录制行人轨迹
Expand Down
59 changes: 36 additions & 23 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,39 +1,52 @@
site_name: 低空模拟器
# site_dir: build_docs
# repo_url: https://github.com/microsoft/airsim
site_description: 'Open source simulator based on Unreal Engine for autonomous vehicles from Microsoft AI & Research'
repo_url: https://github.com/OpenHUTB/air_doc


markdown_extensions:
- toc:
permalink: "#"
- pymdownx.arithmatex:
generic: true
- pymdownx.extra:
- admonition
- pymdownx.blocks.html
- admonition
- mdx_math
- pymdownx.superfences:
custom_fences: [
{ name: flow, class: uml-flowchart }
,{ name: sequence, class: uml-sequence-diagram }
,{ name: mermaid, class: mermaid }
]

remote_branch: gh-pages

theme:
name: 'readthedocs'
logo: ''
name: readthedocs
sticky_navigation: True
navigation_depth: 3
features:
- search.suggest # 在目录栏中的搜索框中输入一些字母时推荐补全整个单词
extra_css: [extra.css]

extra:
highlightjs: true
feature:
tabs: true
palette:
social:
- type: facebook
link: https://www.facebook.com/groups/1225832467530667/
- type: github-alt
link: https://github.com/Microsoft/AirSim

# mathjax用于单独公式展示
extra_javascript:
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
# - extra.js
- https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.4/MathJax.js?config=TeX-AMS-MML_HTMLorMML
- https://cdn.rawgit.com/knsv/mermaid/6.0.0/dist/mermaid.min.js
- https://cdnjs.cloudflare.com/ajax/libs/raphael/2.2.7/raphael.min.js
- https://cdnjs.cloudflare.com/ajax/libs/underscore.js/1.8.3/underscore-min.js
- https://cdnjs.cloudflare.com/ajax/libs/js-sequence-diagrams/1.0.6/sequence-diagram-min.js
- https://cdnjs.cloudflare.com/ajax/libs/flowchart/1.6.5/flowchart.min.js
- js/umlconvert.js

plugins:
- search:
lang: ja
separator: '[\s\-\.]+'
min_search_length: 1

extra:
generator: false

copyright: OpenHUTB 版权所有 © 2026


nav:
- "主页":
- "主页": 'README.md'
Expand Down
1 change: 0 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
python-markdown-math
imageio
pymdown-extensions
sphinx_rtd_theme
Loading