Compodoc: [QUESTION] Angular 6 Projects support

[froodley]

Overview of the issue

Seems like Angular 6 projects folder is ignored; need to include in the documentation

Operating System, Node.js, npm, compodoc version(s)

Angular configuration, a package.json file in the root folder

Compodoc installed globally or locally ?

If possible sourcecode of the file where it breaks

If possible your terminal logs before the error

Motivation for or Use Case

Reproduce the error

Related issues

Suggest a Fix

[vogloblinsky]

@froodley can you explain a little more ?

[arn-the-long-beard]

Hello.
I am using compodoc and it works perfectly for normal Angular project. ( I like it a lot 👍 )

We are talking for projects generated with the command :ng generate library mylibrary

Such library project are generated inside a " workspace " ( just a standard angular project ) in the folder ./projects,

When I run compodoc in such "workspace" , the ./projects/mylibrary folder is ignored and I cannot get documentation for the library.

Is there something to do to generate the documentation for a homemade angular library ( located in the ./projects/mylibrary ? :)

The way angular libraries are made is different in Angular 6. So maybe we are missing something somewhere :)

[froodley]

What he said :D

Sorry for not elaborating more in the original post, I only had a second at the time.

CompoDoc doesn't pick up on ./projects libraries, as stated. Since this is the "new way" going forward with Angular to develop and deploy modules, it is essential that compodoc be able to parse these repos so we can share the docs for the libraries with our developers.

[arn-the-long-beard]

Hello,

I found out a way to do it.

In the package.json of the workspace ;

add this in the script file => compodoc -p projects/mylibrary/tsconfig.lib.json -s -o -w

Then it works.

But I am not sure this is the proper solution.
It was simple ( I try it Saturday but I did not see that the name is tsconfig.lib.json instead of tsconfig.app.json

What do you think about it ?

[froodley]

Thanks! That worked like a charm. This needs to be added to the official documentation, although in retrospect it's a bit obvious :P

[santoshyadavdev]

I am going through same issue, when i add comments in my code ng build library-name gives lot of warning and error. Any fix for this issue.

[kunjan343]

Actually there is some confusion with the new structure especially when we deal with documentation.
In some apps, ./projects contain user defined module packages which we need to include along with default project it self. But for the others, they can also develop multiple applications in one angular universal project.
Should we have to leave it same or need to define documentation based on list of projects?

[jvegaperez]

Hi there, you can generate documentation for your referenced project if you set your main tsconfig.json file like this script file =>"compodoc -p tsconfig.json -s -o -w" and the tool generate documentation for all items in both projects if it's are referenced in tsconfig.json file

good luck ;)

[frontr-uk]

This is great and works, but it fails to create the doc for the app itself once you introduce ./projects

[vogloblinsky]

@frontr-uk Could you share your project folders structure ?

[abadakhshan]

@arn-the-long-beard

What should I do if I have multiple dependent libraries?

I don't want to create separate documentation for each of them. I want to have a unified documentation site, for all my libraries.

[abadakhshan]

I think my solution works.
But I'm not sure It's true or not.
Please check it.

https://github.com/compodoc/compodoc/issues/767#issuecomment-485065816

[stale[bot]]

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[bot]]

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.

[lock[bot]]

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.