Sphinx Ref Helper
Plugin for Sublime Text 3 that searches all docs in folder for Sphinx references and auto generates :ref:`` in current doc
Details
Installs
- Total 311
- Win 140
- Mac 78
- Linux 93
| Feb 28 | Feb 27 | Feb 26 | Feb 25 | Feb 24 | Feb 23 | Feb 22 | Feb 21 | Feb 20 | Feb 19 | Feb 18 | Feb 17 | Feb 16 | Feb 15 | Feb 14 | Feb 13 | Feb 12 | Feb 11 | Feb 10 | Feb 9 | Feb 8 | Feb 7 | Feb 6 | Feb 5 | Feb 4 | Feb 3 | Feb 2 | Feb 1 | Jan 31 | Jan 30 | Jan 29 | Jan 28 | Jan 27 | Jan 26 | Jan 25 | Jan 24 | Jan 23 | Jan 22 | Jan 21 | Jan 20 | Jan 19 | Jan 18 | Jan 17 | Jan 16 | Jan 15 | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Windows | 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 |
| Mac | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 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 |
| 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 |
Readme
- Source
- raw.githubusercontent.com
Sphinx Ref Helper
https://img.shields.io/badge/License-Apache%202.0-blue.svgThis plugin works with Sublime Text 3. It searches the first open folder in any given Sublime Text 3 window for Sphinx internal doc references labels. It displays each one it finds (along with the file it was found in) in the quick panel. If you select one (either by clicking or hitting enter) it will insert the correct :ref:`` in the document you are editing at the current cursor location. Note that this plugin stands alone and does not require Sphinx to be installed or the documenation to have been built.
I recommend having just one Sphinx documentation project folder open in any given window.
How to use it
- Open a Sphinx project using “Open Folder." If there is a conf.py, the plugin tries to check if there are "exclude patterns" to avoid.
- Put cursor where you want to insert :ref:``.
- Type (primary + 1 - "ctrl key" in Windows/Linux and "⌘ key" in MacOS).
- Select ref from the list to insert at current cursor location.
Manual installation
- Open Sublime Text 3.
- Go to “Preferences” and click “Browse Packages.”
- Double click on the “User” directory.
- Drop both files in the “User” directory.
Limitations
This plugin was created to help me work with Sphinx documentation projects that I might not already be familiar with. As such, it is meant for convenience and is a work in progress.
- Try to open folders that contain just the Sphinx project. Opening the root directory of your system would be a bad idea and will probably hang Sublime Text. Don't try it, please.
- Multiple folders open in the same window are going to be a problem, as the plugin is coded to look at only the first folder. It works for me, but it might not work for you. It seems to me that sharing refs between projects would probably be confusing anyway.
- I put in some code to strip out http link refs. However, if your links split lines, they're going to show up in the list. Since many of these are only available from within the file in which they were created, be careful.
- There are probably things that I missed. Feel free to help out.