cibernox / ember-cli-yuidoc

EmberCLI addon for generate documentation from YUIDoc coments
MIT License
55 stars 25 forks source link

Autoreload docs page #6

Open sivakumar-kailasam opened 9 years ago

sivakumar-kailasam commented 9 years ago

When running ember serve --docs I thought the docs page would have an auto-reload which it didn't. Would be a timesaver to have it.

cibernox commented 9 years ago

It should have auto-reload. Depending in the size of the project it can be a bit slow, but it is indeed one of the thinks that make it useful.

Can you check it again? I would love to fix it if there is any scenario i've not covered.

sivakumar-kailasam commented 9 years ago

I see the generation in output of the compiler during auto-reload of the app. But the http://0.0.0.0:4200/docs/ page doesn't seem to reload.

sivakumar-kailasam commented 9 years ago

Also the project is relatively small with just about 10 classes.

cibernox commented 9 years ago

Can you clone this and check if it works for you? https://github.com/cibernox/ember-cli-accounting

If it does, there must be something different in your project. It's an app or an addon? What do you have in your yuidoc.json manifest?

sivakumar-kailasam commented 9 years ago

didn't work there as well. Mine is an app. here's my yuidocs.json

   {
     "name": "something",
     "version": "0.0.0",
     "options": {
       "paths": [
         "app"
       ],
       "exclude": "vendor",
       "outdir": "docs"
     }
  }
cibernox commented 9 years ago

Have you figured out what the problem is? I've used this in a few projects, including in ember.js itself, and I've never had a problem.

sivakumar-kailasam commented 9 years ago

Although the app page reloads the docs page doesn't. I don't see livereload snippet on the docs page, so how would it autoreload?

cibernox commented 9 years ago

Ok, I think we were talking about different things the entire time. My bad probably.

If you change a file and you reload your browser, you should see the changes. There is change detection.

But I haven't implemented anything like live-reload that refreshes the browser for you. You have a manual refresh.

It is indeed a good idea.