API docs epub/html

benluo

Is their any tools to make a epub/html of API locally? And it will be much more helpful for localhost developing environment.

And it's also great for e-ink reader.

unwiredben

No, but it's not a bad idea. For the Enyo 1 docs, I modified the API tool to output everything on one page -- you could then copy that HTML and paste it into other tools. The Enyo 2 API tool is a bit different, but I think the core analysis part is similar.

I will note that everything that's in the API docs is also in the Enyo source files as comments, so you can find those docs just by grepping the source.

phil_bw

I agree, a local version of the docs would be awesome. I've thought about writing a script of sorts myself to extract the docs but have got too many projects as it is.

unwiredben

I've just filed https://github.com/enyojs/enyo/issues/51 to track this.

sjmiles

You can get local docs just by running the API tool from localhost.

Getting static HTML version is useful, but it's not necessary for 'local'.

benluo

yes. It works when I run "chrome --allow-file-access-from-files". Thanks.

But if it can be exported to different formats for IDE/editor to "auto complete", it should accelerate coding speed.

sjmiles

Fwiw, I strongly encourage all web developers to run a local server.

Testing from http:// is more "real-world" then testing from file://, and if nothing else, you will probably learn something about server configurations.

There are really easy to set up web servers for every OS. Personally, I recommend Apache.

Scott

phil_bw

I run a local server for all of my testing needs but I still like good separate stand alone documentation. I know I'll get a lot of groans when I say this but I would love to see the docs in a windows chm file. I know it's a dated format and is really html underneath but it's so quick and easy to navigate.

benluo

I found the source codes of enyo have tons of useful comments. But they are not displayed in API tools. The reason is to keep API tools simple, or just another feature which will come with next version.

unwiredben

The API tool is triggered by comments starting with /** or //* -- other comments may not be formatted appropriately or may be for private or protected methods.

StanleyKrute

> strongly encourage ... run a local server

Deep agreement.

In the Win world, I use and recommend Wamp Server. Easy, Just Works.

benluo

apache 2.2 for windows is enough for me as static files httpd server.

unwiredben

Looks like Wamp Server is just a bundled installation of Apache, PHP, and MySQL.

StanleyKrute

> just a bundled installation

Yep. With everything made to Just Work without much/any tinkering.