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

Hover​Docs

by gladclef ST4

In-line documentation display in Sublime Text

Details

  • 1.1.0
  • github.​com
  • github.​com
  • 4 months ago
  • 35 minutes ago
  • 4 months ago

Installs

  • Total 115
  • Win 58
  • Mac 32
  • Linux 25
Dec 1 Nov 30 Nov 29 Nov 28 Nov 27 Nov 26 Nov 25 Nov 24 Nov 23 Nov 22 Nov 21 Nov 20 Nov 19 Nov 18 Nov 17 Nov 16 Nov 15 Nov 14 Nov 13 Nov 12 Nov 11 Nov 10 Nov 9 Nov 8 Nov 7 Nov 6 Nov 5 Nov 4 Nov 3 Nov 2 Nov 1 Oct 31 Oct 30 Oct 29 Oct 28 Oct 27 Oct 26 Oct 25 Oct 24 Oct 23 Oct 22 Oct 21 Oct 20 Oct 19 Oct 18
Windows 0 1 1 0 1 0 0 0 0 0 0 0 1 0 0 0 0 1 0 1 3 0 0 1 0 0 1 0 0 0 0 0 0 0 0 1 1 0 1 0 0 0 1 1 0
Mac 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 1 0 0 0 0 0 0 0 0 0 1 0 0 0 1 0 1 0 1
Linux 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 1 0 0 0 0 0 0 0 0 0 0 2 0 0 0 1 0 0 0 0 0 0 0 0 0

Readme

Source
raw.​githubusercontent.​com

HoverDocs

In-line documentation display in Sublime Text.

Features

  • finds definitions and documentation
  • displays as a popup (below text) or annotation (to the right side)
  • hyperlink to quickly move to the definition, or open it in a transient view
  • configure popups to show with hover, double click, or key binding
  • toggle how hyperlinks work with ctrl key (Windows only)

Demo

Demo Gif

Is this package right for me?

If you haven't heard of the LSP package before then please go look at it! It is a very cool plugin that talks to language servers for your language of choice to get more intelligent information about your code.

That being said, there are certain situations in which this package is more useful. HoverDocs is lightweight, doesn't require the installation of additional language servers, and doesn't require any complex environment setup. If any of these situations sound like they apply to you, then you've come to the right place.

Installation

You can install the package with Package Control or manually.

Install with Package Control

  1. Press Ctrl+Shift+P (or Cmd+Shift+P on Mac) to open the Command Palette
  2. Select Package Control: Install Package
  3. Select HoverDocs

Install Manually

  1. Click the Preferences > Browse Packages… menu, this should open a folder Packages.
  2. Download https://github.com/gladclef/HoverDocs and move it to that directory.
  3. Restart Sublime Text.

Key Bindings

There's some example key bindings available. Go to Preferences > Package Settings > HoverDocs > Key Bindings to set them.

Caveats

I've only tested this package with python code. It should be compatible with any language. If you try it and have any issues, please let me know!