Sublime Text 3/4 plugin for quick access to Elixir documentation
- Total 384
- Win 69
- Mac 200
- Linux 115
|Jun 5||Jun 4||Jun 3||Jun 2||Jun 1||May 31||May 30||May 29||May 28||May 27||May 26||May 25||May 24||May 23||May 22||May 21||May 20||May 19||May 18||May 17||May 16||May 15||May 14||May 13||May 12||May 11||May 10||May 9||May 8||May 7||May 6||May 5||May 4||May 3||May 2||May 1||Apr 30||Apr 29||Apr 28||Apr 27||Apr 26||Apr 25||Apr 24||Apr 23||Apr 22||Apr 21|
A Sublime Text ¾ plugin for quick navigation to HexDocs documentation for modules in Elixir and in project dependencies.
Installing with Package Control
⌘/Ctrl + Shift + Pto open the command palette.
Package Control: Install Packageand press enter. Then search for
ElixirDocs, select the package and hit enter.
- Open up the command palette with
⌘/Ctrl + Shift + P
- Select the
Elixir Docscommand to see a filterable list of Elixir modules
- Once you've found the module you're interested in, hit enter to navigate to the documentation in your default browser
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 are most likely not going to be shown in the dropdown.
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.