Skip to content

Commit d77cd5d

Browse files
committed
docs: Update to typedoc 0.28 and use entryPointStrategy: packages
1 parent c9fc47e commit d77cd5d

File tree

17 files changed

+196
-82
lines changed

17 files changed

+196
-82
lines changed

.github/workflows/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@ jobs:
2121
- run: npm run build --workspaces
2222
- run: npm test
2323
- run: npm run lint
24-
- run: npm run docs --workspaces
24+
- run: npm run docs

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Build and test all packages at once:
8181
$ npm run build --workspaces
8282
$ npm run lint
8383
$ npm run test
84-
$ npm run docs --workspaces
84+
$ npm run docs
8585

8686
Each package may also be built separately by running `npm run build` in
8787
its directory.

fluent-bundle/package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@
4141
"scripts": {
4242
"build": "tsc",
4343
"postbuild": "rollup -c ../rollup.config.mjs",
44-
"docs": "typedoc --options ../typedoc.config.cjs",
4544
"test": "mocha 'test/*_test.js'"
4645
},
4746
"engines": {

fluent-bundle/typedoc.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"intentionallyNotExported": ["Pattern", "TemporalObject"]
3+
}

fluent-dedent/package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@
2626
"scripts": {
2727
"build": "tsc",
2828
"postbuild": "rollup -c ../rollup.config.mjs",
29-
"docs": "typedoc --options ../typedoc.config.cjs",
3029
"test": "mocha 'test/*_test.js'"
3130
},
3231
"engines": {

fluent-dom/package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@
3636
"scripts": {
3737
"build": "tsc",
3838
"postbuild": "rollup -c ../rollup.config.mjs --globals cached-iterable:CachedIterable",
39-
"docs": "typedoc --options ../typedoc.config.cjs src/index.js",
4039
"test": "c8 mocha -ui tdd --require ./test/index.js 'test/*_test.js'"
4140
},
4241
"engines": {

fluent-dom/typedoc.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"entryPoints": ["src/index.js"]
3+
}

fluent-langneg/package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@
3434
"scripts": {
3535
"build": "tsc",
3636
"postbuild": "rollup -c ../rollup.config.mjs",
37-
"docs": "typedoc --options ../typedoc.config.cjs",
3837
"test": "mocha 'test/*_test.js'"
3938
},
4039
"engines": {

fluent-react/package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@
4343
"scripts": {
4444
"build": "tsc -p ./tsconfig.build.json",
4545
"postbuild": "rollup -c ../rollup.config.mjs --globals @fluent/sequence:FluentSequence,cached-iterable:CachedIterable,react:React",
46-
"docs": "typedoc --options ../typedoc.config.cjs --tsconfig ./tsconfig.build.json",
4746
"test": "jest --collect-coverage"
4847
},
4948
"engines": {

fluent-react/typedoc.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"tsconfig": "./tsconfig.build.json",
3+
}

fluent-sequence/package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@
2929
"scripts": {
3030
"build": "tsc -p ./tsconfig.build.json",
3131
"postbuild": "rollup -c ../rollup.config.mjs",
32-
"docs": "typedoc --options ../typedoc.config.cjs --tsconfig ./tsconfig.build.json",
3332
"test": "mocha 'test/*_test.js'"
3433
},
3534
"engines": {

fluent-syntax/package.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@
4343
"scripts": {
4444
"build": "tsc",
4545
"postbuild": "rollup -c ../rollup.config.mjs",
46-
"docs": "typedoc --options ../typedoc.config.cjs",
4746
"test": "mocha 'test/*_test.js'"
4847
},
4948
"engines": {

fluent-syntax/typedoc.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"categoryOrder": ["Parse", "Serialize", "Data Model"],
3+
"excludeInternal": true
4+
}

0 commit comments

Comments
 (0)