您可以在线阅读 SUMO 文档：https://sumo.dlr.de/docs/
文档会持续更新，始终指向最新的开发版本。
文档的工作流程概述如下：
- 文档以 Markdown 文件的形式进行“开发”或“编写”，这些文件位于 SUMO GitHub 仓库 中。
- 静态 HTML 站点使用 MkDocs 及特定的 MkDocs 插件生成。
要求#
构建文档需要 python3 版本的 mkdocs 以及若干插件。完整的插件列表包含在 docs/web/ 目录下的 requirements.txt 文件中。可以使用 pip 安装这些依赖：
pip install -r requirements.txt
您还需要安装 plantuml 软件包：
sudo apt install plantuml
文档组成部分#
源文件#
Markdown 文件#
每个“页面”或“文章”对应一个 Markdown 文件。这些文件位于 仓库 的 /docs/web/docs/ 目录下，其位置对应于文档中的层级结构（包含内容相关页面的目录）。URI 中观察到的路径对应于 Git 文档目录中的路径。
图片#
页面中包含的图片和其他媒体文件位于 仓库 的 /docs/web/docs/images/ 目录下。
MkDocs 相关文件#
所有构建静态 HTML 页面所需的 MkDocs 相关文件位于 仓库 的 /docs/web/ 目录下。
必要的文件如下：
- 配置文件： 名为 "mkdocs.yml"，包含 MkDocs 的一些构建指令，包括宏（Macros）和一些站点选项。
- 主题： 位于 theme 目录下的所有 HTML、CSS 和 JS 文件。
静态 HTML 页面#
HTML 页面是使用 Markdown 文件构建的。最终的页面可以在 在线文档 中阅读。虽然文档的 源文件 包含在仓库中，但最终的静态 HTML 页面并不包含在内。要获取这些页面的本地副本，请遵循 静态 HTML 站点生成 中的说明。
静态 HTML 站点生成#
静态 HTML 站点的生成在此处说明：https://github.com/eclipse-sumo/sumo/blob/main/docs/web/README.md
可以通过 https://sumo.dlr.de/generate-documentation.php 触发生成（在 DLR 网络内）（或者通过 https://sumo.dlr.de/generate-documentation.php?type=complete 进行完全重建）。