Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ngdocs does not use templateUrl for directive element #155

Open
qwelyt opened this issue Feb 2, 2016 · 1 comment
Open

ngdocs does not use templateUrl for directive element #155

qwelyt opened this issue Feb 2, 2016 · 1 comment

Comments

@qwelyt
Copy link

qwelyt commented Feb 2, 2016

Trying to get started with ngdocs and have created a new project to try and get it up.
I'm using https://github.com/m7r/grunt-ngdocs to generate the documentation.
However, the documentation does not seem to actually work.

I have a directive like in the following example: http://plnkr.co/edit/zxrCfABbQqjWcBJKYB78?p=preview

It's basically a wrapped input with fancy input-checks, as you can see in ssn.js and ssn.html. The directive works, both in the plunker and in my setup (I got a app.js and an index.html, and there the element renders just fine).

How ever, when generating the documentation, the whole 'demo' part of the page is just empty. Looks like this: http://i.imgur.com/bJmdqE8.png

The only way that I seem to be able to get anything in the example page is to write all code inside the <file> tags. And that seems very wrong as this should just be for documentation, and it should actually use the code you have in your files. I've also tried to just include my ssn.html and ssn.js in the file tags using the src option. This does not seem to work though. No matter the path I put in.

So my issue is: How do you actually use ngdocs do generate documentation for a directive that includes a template?

Also, would be nice if there were more documentation about how you actually use this documentation tool...

@wingedfox
Copy link
Contributor

Hi,

ngdocs does not use dgeni-packages for processing sources and rendering templates. You can check the demo of Dgeni-alive generator, it is based on the recent dgeni-packages and renders examples correctly, by specified deployments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants