在自述文件中包含许可证文件

Posted 2023-02-24

【中文标题】在自述文件中包含许可证文件

【英文标题】：Include license file in readme

【发布时间】：2018-01-09 21:44:21

【问题描述】：

我有一个文件 README.rst 用于 PyPi 和 GitHub。

因为我还想在 GitHub 上包含一个许可文件，所以它包含以下行：

.. include:: transcrypt/license_reference.txt

但是，这在 PyPi（整个文件未正确解析）和 GitHub（忽略包含指令）上都不起作用

谁能解释我做错了什么？

【参考方案1】：

看起来 Github 的团队认为（他们可能是对的）允许包含指令可能是一个主要的安全漏洞：https://github.com/github/markup/issues/172

我想他们已经停用了他们第一个渲染引擎的file-insertion-enabled 参数:)

【讨论】：

可能是真的。只有我很难想象为什么包含带有一些奇怪内容的本地文件比直接在主自述文件中包含该内容更危险。谁能解释一下？