Skip to content

Commit

Permalink
chore(docs): Documentation package upgrades and updates (#608)
Browse files Browse the repository at this point in the history
Typedoc related package upgrades:
  - Upgrade typedoc to v0.22.7 everywhere including all packages.
  - Upgrade typedoc-plugin-markdown to v3.11.3.
  - Remove typedoc plugins that are unsupported in typedoc v0.22.7.
    - typedoc-plugin-monorepo: typedoc has added basic support for
      monorepos with entryPointStrategy. There's an open github issue
      for typedoc v0.22.7 support, but currently is not compatible.
    - typedoc-neo-theme: v0.22.0 introduced a breaking change for all
      custom themes. Use the default theme until typedoc-neo-theme is
      updated for v0.22.7.

Consolidate typedoc options in tsconfig.json for all packages. No
need to pass options from typedoc-neo.json to typedoc.

The markdown README for the subpackages are missing from the
documentation. These were previously inserted via typedoc plugins,
but there is an issue open for typedoc slated for the v0.24.0 relase.

Typedoc now provides some tooling for monorepos (entryPoints,
entryPointStrategy, typedocMain). This means that only the exports in
the file specified in typedocMain are now documented.

Add add a commit msg when deploying docs via gh-pages to skip ci.

The following typedoc options have been removed/changed with the
corresponding typedoc release in parenthesis:
  - mode has been removed (v0.20.0)
  - excludeNotExported has been removed (v0.20.0)
  - ignoreCompilerErrors has been removed (v0.20.0)
  - disableOutputCheck has been renamed to cleanOutputDir (v0.22.0)

The hideSources option has been removed from typedoc-plugin-markdown
around v3.2.0
  • Loading branch information
albertseo authored Oct 27, 2021
1 parent 196b896 commit 7d9d0a4
Show file tree
Hide file tree
Showing 16 changed files with 104 additions and 606 deletions.
87 changes: 10 additions & 77 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 3 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
"name": "root",
"private": true,
"devDependencies": {
"@strictsoftware/typedoc-plugin-monorepo": "0.4.2",
"gh-pages": "3.2.3",
"lerna": "4.0.0",
"typedoc": "0.21.4",
"typedoc": "0.22.7",
"typescript": "4.4.4"
},
"scripts": {
Expand All @@ -14,9 +13,9 @@
"check": "lerna run check",
"ci": "npm run check && npm run test && npm run build",
"clean": "lerna run clean",
"docs": "typedoc --options typedoc.json",
"docs": "typedoc",
"docs:deploy": "npm run docs && npm run gh-pages",
"gh-pages": "gh-pages -d docs",
"gh-pages": "gh-pages -m '[skip ci] Update Docs' -d docs",
"lerna-version": "lerna version --conventional-commits --exact --no-push --yes",
"postinstall": "npm run bootstrap",
"test": "lerna run test:cov"
Expand Down
Loading

0 comments on commit 7d9d0a4

Please sign in to comment.