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

TypeDoc does not accept directory path as input file #1692

Closed
srmagura opened this issue Sep 12, 2021 · 1 comment · Fixed by #1693
Closed

TypeDoc does not accept directory path as input file #1692

srmagura opened this issue Sep 12, 2021 · 1 comment · Fixed by #1693
Labels
bug Functionality does not match expectation

Comments

@srmagura
Copy link
Contributor

Search terms

directory, input files

Expected Behavior

According to the options documentation

TypeDoc also accepts directories as input files.

So if I have my TypeScript files in src, I should be able to run typedoc src to generate my documentation.

Actual Behavior

yarn typedoc src results in:

Warning: Unable to locate entry point: C:/Projects/OSS/typedoc-repro/src
Error: Unable to find any entry points. Make sure TypeDoc can find your tsconfig

Steps to reproduce the bug

Repro 1

After merging PR #1691, cd into the examples/basic directory in the TypeDoc repository and run run / run.bat.

Repro 2

I made a simple project to double-verify this issue. See https://github.com/srmagura/typedoc-directory-repro. Run yarn install then yarn typedoc src.

Environment

  • Typedoc version: 0.22.3
  • TypeScript version: 4.4.3
  • Node.js version: 14.17.6
  • OS: Windows 10

BTW, happy to attempt a fix if you can provide some guidance.

@srmagura srmagura added the bug Functionality does not match expectation label Sep 12, 2021
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Sep 12, 2021

This is expected behavior if you don't have an index file under src and entryPointStrategy is set to resolve. It looks like I missed that section of the page when updating it for v0.22 yesterday, updated now!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants