-
Notifications
You must be signed in to change notification settings - Fork 219
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
chore(docs): autogeneration of NoirJS docs #3349
Conversation
New dependencies detected. Learn more about Socket for GitHub ↗︎
|
These docs builds fail and will continue to fail because they depend on other package's build processes. Unfortunately netlify doesn't really provide a way to define a better CI process. However #3296 already solves this by building with the Github CI. So let's block this one until we merge that, and I'll figure out then |
🚀 Deployed on https://6544f6491ff0ff2f5ea2cd07--noir-docs.netlify.app |
gtg @Savio-Sou |
Is it possible to autogenerate links to the source code on github? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is incredible. Thank you @signorecello!
Description
This PR adds autogenerated docs for NoirJS packages, using Typedoc
Problem*
We're spending way too much time changing function signatures and similar stuff. We should be able to rely on autogeneration for that.
Resolves #3199
Summary*
Additional context
I hacked around a bunch of
ignores
here and there, they'd tipically be made private but for some reason they aren't so I'm manually ignoring them. Again, Typedoc expects code to be written in a certain format in order to be documented in a certain way