Request to include help document to build docs for the project using jsduck

[narramadan]

Hi,

I ran gradle to generate the project structure without coffee script. I really love the way the code structure is used and it can be used directly for a production app.

Having no experience on jsduck, I am having trouble on how to generate the docs..A simple ant build or read me would help.

Thanks,
Madan N

[superstructor]

Hi Madan,

Are you using Sencha Cmd at all ? See http://www.sencha.com/products/sencha-cmd/download

We just migrated the build process to Sencha Cmd, which is Ant based. Documentation is generated as part of sencha package build (when executed in the packages/deft directory).

The generated documentation is committed to the repo in packages/deft/docs. I agree it is a good idea to document how to re-generate this.

Cheers
Isaac

[superstructor]

Also do you have JSDuck installed ? What operating system are you using ? Mac / Windows / Linux ?

[narramadan]

Hi Isaac,

We had trouble using Sencha Cmd and DeftJs. There seems a problem to be exists all the time..When one is fixed another opens. So we are skipping Sencha Cmd.

We are using Windows.

Thanks,
Madan N

[superstructor]

When did you last try to use Sencha Cmd with DeftJS ? We only moved the DeftJS repository to use Sencha Cmd this week.

[narramadan]

Its last week..

I just went through 'Adding DeftJS to Your Application' page. I see there are some changes done to use DeftJs with Sencha Cmd..

I will give up a try now..

[superstructor]

Yep Sencha Cmd support is much better now.

Note build may be broken without this pull request: deftjs/DeftJS#99 You could pull that pull request down and try that, other than that its identical to master.

Once that is merged everything should be good. Please let me know if you have any issues.

[narramadan]

As mentioned in the doc, I ran the command for 'sencha repo add -address http://deftjs.org/packages -name deftjs' and did changes to app.json.

When building the app, getting the below error

'[ERR] Failed to download remote catalog : Error downloading http://deftjs.org/pa
ckages/catalog.json'

[superstructor]

Apologies I thought you were going to clone the repository and build the package locally.

The package repository will not be available until deftjs/DeftJS#96 is done for the official 0.9.0 release.

To re-generate the documentation you would have to build the package yourself anyway, the documentation is pre-built in the package file that will be available via the package repository.

To build it yourself and make it available on your local repository this is how I would do it on Linux/Ubuntu. I don't have a Windows machine setup yet to test on but it should be very similar:

1. sencha repo init --email [email protected] --name "My name" (only do this if you have not initialized your local Sencha Cmd repository before)
2. git clone https://github.com/deftjs/DeftJS.git
3. cd DeftJS/packages/deft
4. Edit package.json and change the value of creator from "anonymous" to e.g. "My name"
5. sencha package build (still in the DeftJS/packages/deft directory)
6. sencha package add ../../build/deft/deft.pkg (still in the DeftJS/packages/deft directory)

Now when you do sencha app build right at the top of the output will be something like

[INF] Including code package deft for build
[INF] Package is already local: deft/0.9.0

[narramadan]

Thanks for the quick turn around Isaac. Had to modify the build.xml to comment the Coffee script compilation to get the package build success.

I now created a new workspace and project with sencha cmd. Included the code generated from 'Deft-Template-Generator' sample. Removed inclusion of deft.js in index.html.

Build the app with sencha cmd. Everything went as expected and the project got built with a minor error while trying to copy 'Readme.md'. Below is the error message

[ERR] The following error occurred while executing this line:
D:\mycompany\myproduct\myproduct_FrontEndApp\.sencha\workspace\myproductApp\.sencha\app\build-imp
l.xml:432: The following error occurred while executing this line:
D:\mycompany\myproduct\myproduct_FrontEndApp\.sencha\workspace\MyApp\.sencha\app\build-impl.xml:443: Failed to copy D:\mycompany\myproduct\myproduct_FrontEndApp\packages\deft\resour
ces\Readme.md to D:\mycompany\myproduct\myproduct_FrontEndApp\build\MyApp\production\resources\D:\mycompany\myproduct\myproduct_FrontEndApp\packages\deft\Readme.md due to failed to
create the parent directory for D:\mycompany\myproduct\myproduct_FrontEndApp\build\MyApp\production\resources\D:\mycompany\myproduct\myproduct_FrontEndApp\packages\deft\Readme.md

But the app is build and able to open the view without any errors.

Thanks,
Madan N