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

Elixir​Docs

by reisub ST3

Sublime Text 3/4 plugin for quick access to Elixir documentation

Labels elixir, documentation

Details

Installs

  • Total 589
  • Win 142
  • Mac 272
  • Linux 175
Dec 21 Dec 20 Dec 19 Dec 18 Dec 17 Dec 16 Dec 15 Dec 14 Dec 13 Dec 12 Dec 11 Dec 10 Dec 9 Dec 8 Dec 7 Dec 6 Dec 5 Dec 4 Dec 3 Dec 2 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
Windows 0 0 0 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 0 0 2 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0
Mac 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 1 0 0 0 0 0 0 0 0 0 1 0 1
Linux 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 1 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 1 0 0

Readme

Source
raw.​githubusercontent.​com

ElixirDocs

A Sublime Text ¾ plugin for quick navigation to HexDocs documentation for modules in Elixir and in project dependencies.

Demo

Installing with Package Control

  1. Press ⌘/Ctrl + Shift + P to open the command palette.
  2. Type Package Control: Install Package and press enter. Then search for ElixirDocs, select the package and hit enter.

Usage

  1. Open up the command palette with ⌘/Ctrl + Shift + P
  2. Select the Elixir Docs command to see a filterable list of Elixir modules
  3. Once you've found the module you're interested in, hit enter to navigate to the documentation in your default browser

Known issues

Finding documented modules is done in Python code and is not exact. It's based on regular expressions which operate under certain assumptions. Because of this, you may not be able to find some modules even though they are documented. You also may find some modules which don't have documentation published on HexDocs.

There is no simple fix for this, to make it better one would need to parse the Elixir code into an AST and use the AST to extract information. Furthermore, one would need a fast way to check whether a module has documentation published on HexDocs.

That being said, this is just a convenience to access (most of) the documentation faster - so I'm not sure it's justified to invest the work in making it 100% correct.

Nested modules

Nested modules are most likely not going to be shown in the dropdown.

Contributing

Feedback and contributions are very much welcome. That being said, please don't get upset if I don't get back to you for some time on issues and PRs; life happens :)

By contributing you agree for your work to be published under the same license.