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

is it possible to create docs from npm packages inside node_modules? #2075

Closed
CaveMa opened this issue Oct 14, 2022 · 3 comments
Closed

is it possible to create docs from npm packages inside node_modules? #2075

CaveMa opened this issue Oct 14, 2022 · 3 comments
Labels
question Question about functionality

Comments

@CaveMa
Copy link

CaveMa commented Oct 14, 2022

is it possible to run typedoc on dependency modules inside of node_modules? So a directory structure like

library-src/
           module1/
                  index.ts
                  src/otherfolders/other.ts   
           typedoc.json
           node_modules/
                  @mycompany/src/module2/
                  @mycompany/src/module3/
           tsconfig.ts

and i want docs to be created for @mycompany/src/module2/index.ts and @mycompany/src/module3/index.ts

@CaveMa CaveMa added the question Question about functionality label Oct 14, 2022
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Oct 16, 2022

Yes, you can do this, you just need to specify those files as part of your entry points:

{
  "entryPoints": ["node_modules/@mycompany/src/module2/index.ts", "node_modules/@mycompany/src/module3/index.ts"]
}

... assuming those files are a part of the include in your library-src's tsconfig.json. If they are not, and they have their own tsconfig.json files, you can try --entryPointStrategy packages, and pass the package directories as your entry points.

@CaveMa CaveMa closed this as completed Oct 17, 2022
@boneskull
Copy link
Contributor

I'm not the packages strategy works, since the glob implementation always ignores node_modules.

@boneskull
Copy link
Contributor

Scratch that--it doesn't like symlinks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Question about functionality
Projects
None yet
Development

No branches or pull requests

3 participants