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.

Sign up for GitHub

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

Jump to bottom

docs: generate Typedocs using Aegir #1476

Merged
merged 9 commits into from
Dec 19, 2022
Merged

docs: generate Typedocs using Aegir #1476

merged 9 commits into from
Dec 19, 2022

Conversation

maschad
Copy link
Member

@maschad maschad commented Nov 8, 2022

Closes #1455

@maschad maschad mentioned this pull request Nov 8, 2022
Closed
2 tasks
@maschad maschad force-pushed the docs/generate-docs-ci branch from 89f34c3 to d7ce31e Compare December 2, 2022 20:54
@maschad
Copy link
Member Author

maschad commented Dec 2, 2022

Once ipfs/aegir#1107 is merged and a new version of aegir is released then this can be reviewed.

@maschad maschad marked this pull request as ready for review December 6, 2022 19:34
maschad
maschad commented Dec 6, 2022
View reviewed changes
README.md Show resolved Hide resolved
@maschad maschad force-pushed the docs/generate-docs-ci branch from 1ae7edc to 9bae695 Compare December 6, 2022 19:49
@maschad
Copy link
Member Author

maschad commented Dec 6, 2022

Not sure why CI was failing, rebased and pushed again.

@maschad
Copy link
Member Author

maschad commented Dec 6, 2022

@achingbrain quite a few of the parameters are not exported as modules and therefore no documentation is generated, but they are still referenced by other generated documentation e.g. ConnectionManager or IdentifyService - they are also included in the current API Docs, so do we want to include these? They may not be modules that we want to export but I don't see the downside of exposing them.

@maschad maschad mentioned this pull request Dec 8, 2022
Merged
3 tasks
@achingbrain
Copy link
Member

quite a few of the parameters are not exported as modules and therefore no documentation is generated, but they are still referenced by other generated documentation

I haven't tried it yet but this might help? https://www.npmjs.com/package/typedoc-plugin-missing-exports

@maschad maschad mentioned this pull request Dec 12, 2022
Closed
@maschad maschad marked this pull request as draft December 12, 2022 19:39
@maschad
Copy link
Member Author

maschad commented Dec 12, 2022 •
edited
Loading

Thanks for that recommendation @achingbrain, once ipfs/aegir#1131 is merged and released then I will re-open this for review.

@achingbrain achingbrain force-pushed the docs/generate-docs-ci branch from 9bae695 to 397e703 Compare December 16, 2022 19:16
@achingbrain achingbrain marked this pull request as ready for review December 19, 2022 17:51
@achingbrain achingbrain merged commit 19e96cc into libp2p:master Dec 19, 2022
@mpetrunic mpetrunic mentioned this pull request Jan 10, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@achingbrain achingbrain achingbrain approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs: use Aegir + TypeDoc to generate and serve documentation in CI
2 participants
@maschad @achingbrain