View Sublime Text 3 API documentation directly from within Sublime Text.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
api
build
colorscheme
resources
LICENSE
README.md
SnAPI.py

README.md

SnAPI

SnAPI is a simple package that provides a local copy of the Sublime Text 3 API documentation directly from within Sublime, using the hyperhelp help system for navigation.

SnAPI is pronounced "Snappy", as having API documentation readily available from directly within Sublime keeps you focused on your coding. Also it was a name suggested to me that stuck in my head. Please blame @kingkeith for suggesting the name and my brain for latching onto it so completely.

Also, please note that all help text is taken directly from the above linked official API reference and is Copyright © Sublime HQ Pty Ltd.


NOTE: Although there is only help contained within the package, it is still in active development and as such everything is subject to change.


License

Note that the license below DOES NOT include any of the help files, which are taken from the official API reference for Sublime Text at http://www.sublimetext.com/docs/3/api_reference.html and are Copyright © Sublime HQ Pty Ltd.

All other content in this package are licensed under the MIT License:

Copyright 2017 Terence Martin

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.