-
Notifications
You must be signed in to change notification settings - Fork 77
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
feat(docs): re-write test gen doc flow with pytest plugin #801
Merged
Conversation
This file contains 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
marioevz
approved these changes
Sep 19, 2024
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 absolutely amazing, great PR!
Just some minor comments. Thanks!
Co-authored-by: Mario Vega <marioevz@gmail.com>
Disable duplicate docstrings warning for this PR though
danceratopz
added a commit
that referenced
this pull request
Sep 23, 2024
This was referenced Sep 23, 2024
marioevz
pushed a commit
that referenced
this pull request
Sep 23, 2024
8 tasks
danceratopz
added a commit
that referenced
this pull request
Sep 26, 2024
Co-authored-by: Mario Vega <marioevz@gmail.com>
8 tasks
danceratopz
added a commit
that referenced
this pull request
Sep 27, 2024
Co-authored-by: Mario Vega <marioevz@gmail.com>
danceratopz
added a commit
that referenced
this pull request
Oct 3, 2024
Co-authored-by: Mario Vega <marioevz@gmail.com>
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 is a rewrite of the automatic test case doc generation as a pytest plugin (as apposed to a standalone script). A preview is available at https://ethereum.github.io/execution-spec-tests/pr-801-preview.
Doc Improvements
Technical Improvements
state_test
) can not be determined (both used in the function overview tables on test module pages).🔗 Related Issues
Perhaps solved, plz check whether the styling is acceptable, e.g., test_bls12_g1add/test_valid.html.
Current issues:
Ideas for future improvements:
✅ Checklist
mkdocs serve
locally and verified the auto-generated docs for new tests in the Test Case Reference are correctly formatted.