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

Documents section missing from modules.html when there are no public exports #2722

Closed
mrfigg opened this issue Oct 2, 2024 · 1 comment
Closed
Labels
bug Functionality does not match expectation
Milestone

Comments

@mrfigg
Copy link
Contributor

mrfigg commented Oct 2, 2024

Search terms

packageDocumentation document index missing

Expected Behavior

The 'Documents' section should appear on the index page (modules.html).

Actual Behavior

If a module includes a @packageDocumentation tag containing one or more @document tags and does not have any public exports, the 'Documents' section does not appear on the index page (modules.html).

Steps to reproduce the bug

src/index.ts:

/**
 * @packageDocumentation
 * Example
 *
 * @document ../CHANGELOG.md
 * @document ../LICENSE.md
 * @document ../README.md
 */

/** @private */
export function helloWorld() {
  return "Hello World";
}

typedoc.json:

{
  "entryPoints": ["./src/index.ts"],
  "out": "./docs",
}

docs/modules.html screenshot:
example

Environment

  • Typedoc version: 0.26.7
  • TypeScript version: 5.6.2
  • Node.js version: 20.11.1
  • OS: Windows 10
@mrfigg mrfigg added the bug Functionality does not match expectation label Oct 2, 2024
Gerrit0 added a commit that referenced this issue Oct 4, 2024
@Gerrit0 Gerrit0 added this to the v0.26.7 milestone Oct 4, 2024
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Oct 4, 2024

Fixed with 77cf917

@Gerrit0 Gerrit0 closed this as completed Oct 4, 2024
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

No branches or pull requests

2 participants