Skip to content

Use Improved TypeDoc #79

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

Merged
merged 10 commits into from
Dec 10, 2020
Merged

Use Improved TypeDoc #79

merged 10 commits into from
Dec 10, 2020

Conversation

labkey-nicka
Copy link
Contributor

@labkey-nicka labkey-nicka commented Dec 8, 2020

Rationale

With TypeStrong/typedoc#1364 a contributor to TypeDoc as made some significant improvements to how TypeDoc configures and builds a documentation site. This work uses the latest beta version of TypeDocs to generate a much improved API docs site.

Changes

  • Update TypeDoc to 0.20.0-beta.26 and update our typedoc.js to improve documentation layout.
  • Move "fieldKey" modules to top-level so they better align with how they're actually exported.
  • Improve documentation for filters and their types. Done as part of an exercise to see how TypeDoc handled inline docs.
  • Fixes issues 42014 and 40724 with improvements to Domain documentation.
  • Package updates.

@labkey-nicka labkey-nicka requested a review from cnathe December 8, 2020 18:29
@labkey-nicka labkey-nicka self-assigned this Dec 8, 2020
@labkey-nicka labkey-nicka merged commit f5f74f4 into main Dec 10, 2020
@labkey-nicka labkey-nicka deleted the fb_better_docs branch December 10, 2020 18:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants