You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We are building our own package around dgeni-packages. Our goal is to output json instead of rendered HTML. Our documentation delivery app provides navigation over a single json file for each module.
The process outputs two types of json file:
index.json: lists the modules with high level name and description
module.json: one per module, contains the full module contents -- all components
Actually everything is working fine. We have our own simple json renderer, and a couple of custom processors. It outputs the right files in the right structure 🎱.
But when the process is run, there are warnings such as:
warn: No path template provided - doc "module:module1:directive:testDirective" (directive) - from file "module1/directive.js" - starting at line 2, ending at line 8
warn: No output path template provided - doc "module:module1:directive:testDirective" (directive) - from file "module1/directive.js" - starting at line 2, ending at line 8
In our case we don't want a file for each component, since everything is included in the module.json. How can we suppress this message?
Finally, is there a description somewhere of what pathTemplate is used for? outputPathTemplate is pretty obvious, but am not sure about pathTemplate. I thought it was used to auto-fill properties of the document based on source file path, but that doesn't seem to be the case.
And thanks for a great library. Definitely took some head scratching but now getting the job done!
The text was updated successfully, but these errors were encountered:
jugglingcats
changed the title
Unwanted warnings about path and output path - or mis-understanding
Unwanted warnings about path and output path - or lack of understanding
Jun 4, 2016
We are building our own package around dgeni-packages. Our goal is to output json instead of rendered HTML. Our documentation delivery app provides navigation over a single json file for each module.
The process outputs two types of json file:
Actually everything is working fine. We have our own simple json renderer, and a couple of custom processors. It outputs the right files in the right structure 🎱.
But when the process is run, there are warnings such as:
In our case we don't want a file for each component, since everything is included in the module.json. How can we suppress this message?
Finally, is there a description somewhere of what
pathTemplate
is used for?outputPathTemplate
is pretty obvious, but am not sure aboutpathTemplate
. I thought it was used to auto-fill properties of the document based on source file path, but that doesn't seem to be the case.And thanks for a great library. Definitely took some head scratching but now getting the job done!
The text was updated successfully, but these errors were encountered: