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 518
  • Win 117
  • Mac 246
  • Linux 155
Apr 24 Apr 23 Apr 22 Apr 21 Apr 20 Apr 19 Apr 18 Apr 17 Apr 16 Apr 15 Apr 14 Apr 13 Apr 12 Apr 11 Apr 10 Apr 9 Apr 8 Apr 7 Apr 6 Apr 5 Apr 4 Apr 3 Apr 2 Apr 1 Mar 31 Mar 30 Mar 29 Mar 28 Mar 27 Mar 26 Mar 25 Mar 24 Mar 23 Mar 22 Mar 21 Mar 20 Mar 19 Mar 18 Mar 17 Mar 16 Mar 15 Mar 14 Mar 13 Mar 12 Mar 11
Windows 0 0 0 1 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 1 0 0 0 1 0
Mac 0 0 0 0 1 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 1 0 0 1 0 0 0 1 1 0 0 0 0 0 0
Linux 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 1 0 0 2 0 0 0 0 0 0 0 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.