文档标准

本文档将作为为文档做出贡献而需要遵循的一些规则的指南和示例。

文档结构

我们和 extra.css 一起，混合使用 Markdown 和 HTML 标签来自定义文档和文件。要更新 Python API 文档，您需要编辑 carla/PythonAPI/docs/ 内部相应的 YAML 文件并运行 doc_gen.py 或 make PythonAPI.docs，而不是直接修改 Markdown。

这将在 carla/Docs/ 中重新生成相应的 Markdown 文件，然后可以将其输入到 mkdocs.

规则

  • 各节之间和文档末尾始终留有空行。
  • 除 HTML 相关内容、Markdown 表格、代码片段和引用链接外，书写不应超过 100 列。
  • 如果内联链接超出限制，请使用引用的 [name][reference_link] markdown 符号[reference_link]: https://，而不是[name](https://)。
  • 使用 <br> 进行内联跳转，而不是在行尾留下两个空格。
  • 在新页面的开头使用 <h1>Title</h1> ，以制作标题或 <hx>Heading<hx> 制作不会显示在导航栏上的标题。
  • 使用 ------ 强调标题或 # 层次结构下划线来制作标题并将其显示在导航栏中。

例外情况

  • 通过 Python 脚本生成的文档，例如 PythonAPI 参考

方便的 markdown cheatsheet。