Skip to content

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

@shoogsteyn

Description

@shoogsteyn

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions