Skip to content

Commit 0c07fd7

Browse files
committed
Add docs for packages mode options locations
Resolves #2828
1 parent fa3077c commit 0c07fd7

File tree

5 files changed

+229
-6
lines changed

5 files changed

+229
-6
lines changed

site/options.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ children:
88
- options/organization.md
99
- options/validation.md
1010
- options/other.md
11+
- options/package-options.md
1112
---
1213

1314
Any command line arguments that are passed without a flag will be parsed as entry points.

site/options/input.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,13 @@ sub-projects will _not_ be loaded. See
6868
[Gerrit0/typedoc-packages-example](https://github.com/Gerrit0/typedoc-packages-example)
6969
for an example monorepo which uses this option.
7070

71-
Configuration specified in the root level project will _not_ be copied to child projects.
71+
> [!warning] When running in packages mode, options must be specified in the
72+
> correct location. As TypeDoc effectively runs with a clean options object for
73+
> each directory, options which take effect during conversion must be set within
74+
> [packageOptions](#packageoptions) or directly within configuration for each
75+
> project. Configuration specified in the root level project will _not_ be
76+
> copied to child projects. See the [package options](package-options.md) page
77+
> for documentation about where each option should be set.
7278
7379
### merge
7480

0 commit comments

Comments
 (0)