从代码示例到参考文档的自动链接。
项目描述
sphinx-codeautolink 通过将各个代码元素的链接插入到相应的参考文档中，使代码示例可点击。假设您的示例已经是有效的 Python，我们的目标是进行最小设置。
如需现场演示，请参阅我们关于 Read The Docs的在线文档。
安装
sphinx-codeautolink 可以通过pip从包索引安装。
$ pip install sphinx-codeautolink请注意，该库处于早期开发阶段，因此建议使用版本固定。要启用 sphinx-codeautolink，请修改 conf.py 中的扩展名列表。请注意，扩展名使用下划线而不是连字符。
extensions = [
...,
"sphinx_codeautolink",
]而已！现在您的代码示例已链接。有关连接多个示例和设置默认导入语句的方法，请查看在线文档。
下载文件
下载适用于您平台的文件。如果您不确定要选择哪个，请了解有关安装包的更多信息。
源分布
sphinx-codeautolink-0.12.0.tar.gz
(46.8 kB
查看哈希)
内置分布
关
sphinx_codeautolink -0.12.0-py3-none-any.whl 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | bb29a3b1ac1c7466e5d3b76f57558253f24cb7de0def119c59df3167a01ff678 |
|
| MD5 | b0bb095a6fc00433ac71a2b7f8157d47 |
|
| 布莱克2-256 | c69500ee74a5a15399cd0c450e2cdc727e5f39710c20d4e0ac737c722705bb16 |