Skip to content

Commit

Permalink
Change inline @document tag to projectDocuments in typedoc.json, bu…
Browse files Browse the repository at this point in the history
…t unfortunately there is some weird behavior. Check typedoc#2649 for deetz
  • Loading branch information
nicfv committed Jul 28, 2024
1 parent 4176a6b commit a86473d
Show file tree
Hide file tree
Showing 6 changed files with 3 additions and 5 deletions.
1 change: 0 additions & 1 deletion src/packages/datafit/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
* ```shell
* npm i datafit
* ```
* @document ../CHANGELOG.md
*/
export * from './types';
export * from './lib';
1 change: 0 additions & 1 deletion src/packages/dimensional/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
* ```shell
* npm i dimensional
* ```
* @document ../CHANGELOG.md
*/
export * from './quantity';
export * from './unit';
Expand Down
1 change: 0 additions & 1 deletion src/packages/exray/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
* ```shell
* npm i exray
* ```
* @document ../CHANGELOG.md
*/
/**
* Lightweight framework to expect
Expand Down
1 change: 0 additions & 1 deletion src/packages/smath/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
* ```shell
* npm i smath
* ```
* @document ../CHANGELOG.md
*/
/**
* Contains a small math function library including
Expand Down
1 change: 0 additions & 1 deletion src/packages/viridis/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
* ```shell
* npm i viridis
* ```
* @document ../CHANGELOG.md
*/
export * from './Color';
export * from './Gradient';
Expand Down
3 changes: 3 additions & 0 deletions src/typedoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@
"entryPoints": [
"src/index.ts",
],
"projectDocuments": [
"CHANGELOG.md",
],
},
// "treatValidationWarningsAsErrors": true,
}

0 comments on commit a86473d

Please sign in to comment.