Add possibility to generating documentation for non component libraries

[floratmin]

Description

Add a document generator to nx workspaces to generate documentation for non-component libraries.

Motivation

With storybook there is a very good tool to document components. But for plain libraries there is no such tool for generating documentation.

Suggested Implementation

With typedoc there is an excellent generator. With the help of typedoc.json files in each library we can generate documentation for each library separately. This can already be easily realized with a simple @nrwl/workspace:run-commands. But an integration into library creation could make this process more straight forward.

[kmaraz]

@floratmin would it be possible to share some example repo on how did you set it up please?

[vervallsweg]

@kmaraz That's the target I added to my-lib in workspace.json. Obviously replace the lib name.

	"docs": {
            "executor": "@nrwl/workspace:run-commands",
                "options": {
                "commands": [
                    {
                        "command": "yarn typedoc --tsconfig libs/my-lib/tsconfig.lib.json --out docs/my-lib libs/my-lib/src/index.ts"
                    }
                ]
            }
        }

[wangzishi]

I am also confused with setup typedoc integration with multiple packages in nx monorepo.

[github-actions]

This issue has been automatically marked as stale because it hasn't had any recent activity. It will be closed in 14 days if no further activity occurs.
If we missed this issue please reply to keep it active.
Thanks for being a part of the Nx community! 🙏

[gp187]

+1

[kalebheitzman]

+1

[DaSchTour]

I would expect that it should be possible to create one documentation from the root of the project with all libraries as modules.

But as stated in TypeStrong/typedoc#1791 in seams that typedoc is not able to distinguish modules/libraries.

[github-actions]

This issue has been closed for more than 30 days. If this issue is still occuring, please open a new issue with more recent context.