Skip to content
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

docs: Introduce Typedoc #443

Merged
merged 1 commit into from
Mar 7, 2022
Merged

docs: Introduce Typedoc #443

merged 1 commit into from
Mar 7, 2022

Conversation

fb55
Copy link
Collaborator

@fb55 fb55 commented Mar 7, 2022

The bare minimum to generate docs with Typedoc, and update them on Github Actions. This is needed to have docs again, for eg. #422.

There are quite a few symbols that cannot be resolved right now. Part of the issue is TypeStrong/typedoc#1835, which prevents symbols from being resolved across packages. We also have to expose additional symbols; eg. #301 will be a part of fixing that. All of that will be tackled after this PR.

- run: npm ci
- name: Build docs
run: npm run build:docs
- name: Deploy
Copy link
Collaborator Author

@fb55 fb55 Mar 7, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This pushes built docs to the gh-pages branch. The repo settings will have to be updated to use that branch as the source for GitHub Pages.

@fb55 fb55 merged commit 1263c48 into master Mar 7, 2022
@fb55 fb55 deleted the typedoc branch March 7, 2022 15:57
jmbpwtw pushed a commit to jmbpwtw/parse5 that referenced this pull request Feb 16, 2023
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