ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Sphinx Ref Helper

Plugin for Sublime Text 3 that searches all docs in folder for Sphinx references and auto generates :ref:`` in current doc

Labels sphinx

Details

Installs

  • Total 57
  • Win 26
  • OS X 15
  • Linux 16
Oct 19 Oct 18 Oct 17 Oct 16 Oct 15 Oct 14 Oct 13 Oct 12 Oct 11 Oct 10 Oct 9 Oct 8 Oct 7 Oct 6 Oct 5 Oct 4 Oct 3 Oct 2 Oct 1 Sep 30 Sep 29 Sep 28 Sep 27 Sep 26 Sep 25 Sep 24 Sep 23 Sep 22 Sep 21 Sep 20 Sep 19 Sep 18 Sep 17 Sep 16 Sep 15 Sep 14 Sep 13 Sep 12 Sep 11 Sep 10 Sep 9 Sep 8 Sep 7 Sep 6 Sep 5 Sep 4
Windows 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 1 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
OS X 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 1 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 1
Linux 0 0 0 0 0 0 0 1 2 0 0 0 0 0 0 0 0 1 0 0 0 0 1 0 2 0 0 0 0 0 0 0 1 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.svg

This 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.

images/sphinx-ref-help-screenshot.png

I recommend having just one Sphinx documentation project folder open in any given window.

How to use it

  1. 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.
  2. Put cursor where you want to insert :ref:``.
  3. Type (primary + 1 - "ctrl key" in Windows/Linux and "⌘ key" in MacOS).
  4. Select ref from the list to insert at current cursor location.

Manual installation

  1. Open Sublime Text 3.
  2. Go to “Preferences” and click “Browse Packages.”
  3. Double click on the “User” directory.
  4. 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.