添加文档

要添加新的文档,请在树中的 moz.build 文件中定义 SPHINX_TREESSPHINX_PYTHON_PACKAGE_DIRS 变量,文档将自动被提取。

假设您有一个名为 featureX 的目录,您希望为其编写一些文档。以下是为其创建 Sphinx 文档的步骤

  1. 为文档创建一个目录。这通常是 docs。例如 featureX/docs

  2. 在此目录中创建一个 index.rst 文件。index.rst 文件是该部分的根文档。请参阅 build/docs/index.rst 以获取示例文件。

  3. moz.build 文件(通常是 docs 目录的父目录中的文件)中,定义 SPHINX_TREES 以连接管道。例如 SPHINX_TREES['featureX'] = 'docs'。这意味着当前目录下的 ``docs`` 目录应安装到 Sphinx 文档树的 ``/featureX`` 下

  4. 如果您有一些 Python 包,您希望为其生成 Python API 文档,您可以使用 SPHINX_PYTHON_PACKAGE_DIRS 来声明包含 Python 包的目录。例如 SPHINX_PYTHON_PACKAGE_DIRS += ['mozpackage']

  5. docs/config.yml 中,定义文档应该属于哪个类别。

  6. 使用 ./mach lint -l rst 验证 rst 语法