Sphinx Ref Helper
这是Sublime Text 3的一个插件,可以在文件夹中的所有文档中搜索Sphinx参考,并在当前文档中自动生成 :ref:``
标签 sphinx
详细信息
安装
- 总和 302
- Win 136
- Mac 75
- Linux 91
8月6日 | 8月5日 | 8月4日 | 8月3日 | 8月2日 | 8月1日 | 7月31日 | 7月30日 | 7月29日 | 7月28日 | 7月27日 | 7月26日 | 7月25日 | 7月24日 | 7月23日 | 7月22日 | 7月21日 | 7月20日 | 7月19日 | 7月18日 | 7月17日 | 7月16日 | 7月15日 | 7月14日 | 7月13日 | 7月12日 | 7月11日 | 7月10日 | 7月9日 | 7月8日 | 7月7日 | 7月6日 | 7月5日 | 7月4日 | 7月3日 | 7月2日 | 7月1日 | 6月30日 | 6月29日 | 6月28日 | 6月27日 | 6月26日 | 6月25日 | 6月24日 | 6月23日 | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Windows | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
Mac | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
Linux | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
说明
Sphinx Ref Helper
https://img.shields.io/badge/License-Apache%202.0-blue.svg此插件适用于Sublime Text 3。它会搜索给定窗口中任何打开的文件夹中的Sphinx内部文档参考标签。它将在快速面板中显示发现的每个标签(以及找到的文件)。如果您选择其中一个(无论是通过点击还是按回车键),它将在您正在编辑的文档中当前位置插入正确的 :ref:``。请注意,此插件独立运行,不需要安装Sphinx或生成交档。
建议在任一窗口中只打开一个Sphinx文档项目文件夹。
如何使用
- 使用“打开文件夹”打开Sphinx项目。如果存在 conf.py,插件会尝试检查是否存在“排除模式”以避免。
- 将光标置于您想插入 :ref:`` 的位置。
- 输入(主要 + 1 - 在Windows/Linux中为“ctrl键”,在MacOS中为“⌘键”)。
- 从列表中选择要插入当前光标位置的参考。
手动安装
- 打开Sublime Text 3。
- 转到“偏好设置”并点击“浏览包”。
- 双击“User”目录。
- 将两个文件拖放到“User”目录中。
限制
此插件是为帮助我处理可能不熟悉的Sphinx文档项目而创建的。因此,它旨在方便使用,并仍在开发中。
- 尽量只打开包含Sphinx项目的文件夹。打开系统根目录将是个糟糕的想法,可能会导致Sublime Text停止响应。请不要尝试。
- 在同一窗口中打开多个文件夹将存在问题,因为插件仅编码为查看第一个文件夹。这对我来说没问题,但可能对您不起作用。在我看来,在项目间共享引用可能会令人困惑。
- 我添加了一些代码来去除http链接引用。然而,如果您的链接分多行,它们将出现在列表中。由于许多这些链接只有在创建它们的文件内才可用,请小心。
- 可能还有一些我遗漏的东西。请随时协助。