chore(docs): autogeneration of NoirJS docs#3349
Merged
Conversation
|
New dependencies detected. Learn more about Socket for GitHub ↗︎
|
Contributor
Author
|
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 |
Contributor
|
🚀 Deployed on https://6544f6491ff0ff2f5ea2cd07--noir-docs.netlify.app |
Contributor
Author
|
gtg @Savio-Sou |
Contributor
|
Is it possible to autogenerate links to the source code on github? |
Savio-Sou
approved these changes
Nov 6, 2023
Collaborator
Savio-Sou
left a comment
There was a problem hiding this comment.
This is incredible. Thank you @signorecello!
This was referenced Nov 6, 2023
TomAFrench
pushed a commit
that referenced
this pull request
Nov 14, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
ignoreshere 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