Sublime Text 3/4 plugin for quick access to Elixir documentation
- Total 220
- Win 40
- Mac 112
- Linux 68
|Aug 16||Aug 15||Aug 14||Aug 13||Aug 12||Aug 11||Aug 10||Aug 9||Aug 8||Aug 7||Aug 6||Aug 5||Aug 4||Aug 3||Aug 2||Aug 1||Jul 31||Jul 30||Jul 29||Jul 28||Jul 27||Jul 26||Jul 25||Jul 24||Jul 23||Jul 22||Jul 21||Jul 20||Jul 19||Jul 18||Jul 17||Jul 16||Jul 15||Jul 14||Jul 13||Jul 12||Jul 11||Jul 10||Jul 9||Jul 8||Jul 7||Jul 6||Jul 5||Jul 4||Jul 3||Jul 2|
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.