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

[BUG] Problem trying to exclude part of the project from documentation generation #102

Closed
shoogsteyn opened this issue Feb 6, 2017 · 2 comments

Comments

@shoogsteyn
Copy link

Hi, first of all thanks for your work. To this day compodoc's the best tool to document angular2 project !

Overview of the issue

The issue I have is that my project is quite massive and I would like to exclude some module from the documentation. In order to do that I have create a tsconfig.json speficique for documentation generation. In the file I exclude the module that should not be documented at the time.

compodoc -p tsconfig.doc.json

In the tsconfig.doc.json :

"exclude": [
"src/app/exampleModule",
]

I have try exclude the directory, only the exampleModule.module.ts, event a file in particular, nothing seems to work.

Is there another way to exclude module/file from documentation generation ?

Thanks

@vogloblinsky vogloblinsky changed the title [BUG] Problem trying to exclude part of the project from documentation generation [FEATURE] Problem trying to exclude part of the project from documentation generation Feb 6, 2017
@vogloblinsky
Copy link
Contributor

The exclude method with tsconfig is a good one.
Just made a test, it is the excluding stuff of Compodoc which doesn' t works well.
I will fix soon, coming in next release this week.

@vogloblinsky vogloblinsky changed the title [FEATURE] Problem trying to exclude part of the project from documentation generation [BUG] Problem trying to exclude part of the project from documentation generation Feb 6, 2017
@lock
Copy link

lock bot commented Oct 1, 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 Oct 1, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants