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

[QUESTION] cannot generate Docs #780

Closed
xxyyzz2050 opened this issue Apr 30, 2019 · 6 comments
Closed

[QUESTION] cannot generate Docs #780

xxyyzz2050 opened this issue Apr 30, 2019 · 6 comments
Labels

Comments

@xxyyzz2050
Copy link

I cannot generate docs for this project, even though it works well without Angular or typescript errors, and I can serve it in the browser.

also, I need to exclude some dirs from the docs. for example I want to generate separate docs for each library in my project,
or to not include 'test' folders in my docs, because they just created for testing purposes.

I use angular universal,
and I made compodoc options as a property in my package.json

another note:
when I remove "-p package.json" from the cmd, it gives an error: tsconfig.json not found

@Trewaters
Copy link

I just discovered compodoc a couple days ago but I was able to build documentation using this in my package json scripts...

"compodoc":"npx compodoc -p src/tsconfig.app.json"

When I run this npm run compodoc it builds for me. Hope that helps.

@vogloblinsky
Copy link
Contributor

@xxyyzz2050 just works for me with this :

compodoc -p src/tsconfig.app.json

@vogloblinsky vogloblinsky changed the title cannot generate Docs [QUESTION] cannot generate Docs Apr 30, 2019
@xxyyzz2050
Copy link
Author

xxyyzz2050 commented May 1, 2019

I don't have a problem with the command itself, it makes compoDoc run (regardless of the issue that it dosen't discover package.json itself unless I pass -p package.json),

but running compodoc causes an error in some files. please clone the repo and try to run compodoc to see the error

@vogloblinsky @Trewaters

@stale
Copy link

stale bot commented Sep 30, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the wontfix label Sep 30, 2019
@stale
Copy link

stale bot commented Oct 7, 2019

This issue has been automatically closed because it has not had recent activity. Please file a new issue if you are encountering a similar or related problem. Thank you for your contributions.

@stale stale bot closed this as completed Oct 7, 2019
@lock
Copy link

lock bot commented Dec 6, 2019

This issue has been automatically locked due to inactivity. Please file a new issue if you are encountering a similar or related problem. Why locking ? Having issues with the most up-to-date context.

@lock lock bot locked as resolved and limited conversation to collaborators Dec 6, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

3 participants