sphinx-all-contributors

sphinx-all-contributors 是一个Sphinx扩展，它允许您轻松地从您的Sphinx文档中的 .all-contributorsrc 文件显示贡献者列表。该列表以简单、易读的格式生成，例如

- Contributor Name 1 - ideas, docs
- Contributor Name 2 - code

功能

• 自动从 .all-contributorsrc 文件读取贡献者列表。
• 可自定义到 .all-contributorsrc 文件的相对路径。
• 以干净、易于阅读的格式输出贡献者列表。

安装

1. 克隆或下载此存储库。
2. 运行以下命令安装包

pip install .

使用方法

将 sphinx-all-contributors 添加到 conf.py 中的 extensions 列表

# conf.py
extensions = [
    "sphinx_all_contributors",
    # other extensions
]

在您的文档源目录（或另一个位置）中创建一个 .all-contributorsrc 文件。您可以通过遵循 all-contributors 格式手动创建此文件，或者使用 all-contributors bot 来自动化此过程并确保您的贡献者数据准确且最新。一个示例 .all-contributorsrc 文件如下所示

{
  "contributors": [
    {
      "name": "Contributor Name 1",
      "contributions": ["ideas", "docs"]
    },
    {
      "name": "Contributor Name 2",
      "contributions": ["code"]
    }
  ]
}

在您的 .rst 文件中，使用 all-contributors 指令显示贡献者列表。您可以指定到 .all-contributorsrc 文件的相对路径或省略它以使用默认路径（源目录中的 .all-contributorsrc）。

示例 1：使用默认的 .all-contributorsrc 路径

.. all-contributors::

示例 2：指定到 .all-contributorsrc 文件的相对路径

.. all-contributors:: config/.all-contributorsrc

构建您的文档

make html

生成的HTML（或其他格式）将包含以下格式的贡献者列表

- Contributor Name 1 - ideas, docs
- Contributor Name 2 - code