PDA

View Full Version : Ext5 offline docs



nomack84
3 Apr 2014, 10:42 AM
When it will be available an offline version of the docs? In ST there is an offline version for those, like me, that can not be connected to internet all the time.

I know the docs are not ready yet, but a it will be good to be able to download the api docs the way is now, at least.

superstructor
3 Apr 2014, 5:22 PM
Are you aware you can generate the API portion of the docs with https://github.com/senchalabs/jsduck ? Albeit missing the guides etc.

If you want an example of how to do that reply and I'll post one.

nomack84
4 Apr 2014, 4:08 AM
Thanks! That's good enought for now! The guides are no problem, I can read them online, but the API not.

superstructor
5 Apr 2014, 12:22 PM
$ gem install --prerelease jsduck
Successfully installed jsduck-6.0.0beta
1 gem installed


$ jsduck --builtin-classes --warnings=-no_doc,-no_doc_member --external=XMLHttpRequest,Uint8Array,Document,Window --footer="Ext JS 5.0.0 Docs - Generated with <a href='https://github.com/senchalabs/jsduck'>JSDuck</a> {VERSION}. <a href='http://www.sencha.com/legal/terms-of-use/'>Terms of Use</a>" --output=docs src examples/ux packages/sencha-core/src packages/sencha-amf/src packages/sencha-charts/src packages/sencha-soap/src packages/ext-theme-base/sass packages/ext-theme-classic/sass packages/ext-theme-classic-sandbox/sass packages/ext-theme-crisp/sass packages/ext-theme-gray/sass packages/ext-theme-neptune/sass packages/ext-theme-neptune-touch/sass packages/ext-theme-neutral/sass


Note the inclusion of the src directory as well as all the code and theme package src or sass directories.

tangix
7 Apr 2014, 12:25 AM
How nice it would be to just have a separate zip-file available for download... just thinking...

modestemax
7 Apr 2014, 4:35 AM
one of the value added of EXTJS is its offline good docs, please we need it; our internet connection is not so good.don't forget African Developer.

superstructor
7 Apr 2014, 5:20 AM
I'm sure a separate zip-file download will come eventually.

In the meantime its a great opportunity to try out JsDuck. Not only can it generate the documentation for Sencha's code; it can also add in documentation for your own code. All within the same awesome and offline-capable GUI. This is a major benefit of having JsDuck installed and using as per above example.

To add generated documentation for your own code just add your own app / src directories to the list of directories.

tangix
23 Oct 2014, 12:20 AM
Just for the record. To create the offline docs on Linux Mint 17 you need to do this before you can run jsdock in the ext-5.0.1 directory:

$ sudo apt-get install ruby ruby-dev
$ sudo gem install --prerelease jsduck