python-sphinx - 使用 Sphinx 引用特定文件

Question

在我正在进行的一个项目中，文档是使用 Sphinx 完成的。README.md 确实提到了位于名为 .github 的文件夹中的 CONTRIBUTING.md。

在构建文档时，贡献文件的链接变成了https://myproject.github.io/.github/CONTRIBUTING.md但这实际上并不存在。

我正在寻找一种方法来告诉 sphinx 爬过 .github/*.md。我在互联网上找到的许多解决方案都不起作用（主要使用 .. include::)。我能做的最好的就是复制 docs 文件夹中的 .github 文件夹，然后使用 .. include:: 但这不是很令人满意。

有谁知道如何在不破坏大部分文件夹树的情况下实现这一目标？（我不是项目负责人，因此可能不会接受更大的更改）

标签： python-sphinx