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

Unwanted warnings about path and output path - or lack of understanding #182

Open
jugglingcats opened this issue Jun 4, 2016 · 0 comments

Comments

@jugglingcats
Copy link

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!

@jugglingcats 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
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

1 participant