将文档测试添加到我的降价中时,我必须编写类似的内容
```蟒蛇 >>>导入numpy >>>np.sum([1, 2]) 3 ````
这与 doctest 配合得很好。然而,当我在 Github 上渲染 markdown 页面时,很难复制/粘贴示例,因为交互式 Python 部分(例如
>>>
)仍然存在。
例如,在 doctest 本身的 Python 文档上:https://docs.python.org/3/library/doctest.html#how-are-docstring-examples-recognized 人们可以单击“隐藏提示”按钮和输出”,这使得复制变得容易。 Github markdown 渲染也能实现同样的效果吗?
这在 GitHub markdown 中是不可能的。作为解决方法,您可以提供文档测试版本和代码的普通版本。
如果您确实需要更具交互性的解决方案,您可以考虑使用静态站点生成器(例如带有自定义插件的 Jekyll 或 MkDocs)或 JavaScript 来切换提示和输出的可见性。该解决方案的缺点是它需要您自己在 GitHub 的本机 Markdown 渲染之外托管文档。