文档工程

技术栈

当前文档中心使用:

  • Sphinx

  • Furo theme

  • MyST-Parser

  • Breathe

  • Exhale

  • sphinx-copybutton

  • sphinx-design

支持的文档格式

格式

用途

.rst

Sphinx 原生结构化文档、目录、API 页面

.md

产品说明、教程、快速开始、Markdown 文档

Doxygen XML

C/C++ API 自动文档输入

本地构建

cd docs
python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
make html

输出目录:

docs/build/html