-
Notifications
You must be signed in to change notification settings - Fork 384
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
Refactoring Docs to use JupyText #49
Merged
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
rdheekonda
approved these changes
Feb 20, 2024
rdheekonda
reviewed
Feb 20, 2024
romanlutz
approved these changes
Feb 20, 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.
Thank you for figuring out the doc tests!
nina-msft
reviewed
Feb 20, 2024
nina-msft
reviewed
Feb 20, 2024
nina-msft
reviewed
Feb 20, 2024
nina-msft
reviewed
Feb 20, 2024
nina-msft
reviewed
Feb 20, 2024
6 tasks
Co-authored-by: Roman Lutz <romanlutz13@gmail.com>
Co-authored-by: Roman Lutz <romanlutz13@gmail.com>
Co-authored-by: Roman Lutz <romanlutz13@gmail.com>
Co-authored-by: Roman Lutz <romanlutz13@gmail.com>
…e/PyRIT into users/rlundeen/2_6_jupytext
Co-authored-by: Roman Lutz <romanlutz13@gmail.com>
Co-authored-by: Roman Lutz <romanlutz13@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 PR refactors the docs to use jupytext to generate jupyter notebooks. For us, this has the advantage of being more testable and reviewable. From the Documentation Contributor Guide
.md
file or a.py
file in the percent format file (this will generate to .ipynb for consumption).ipynb
files directly. These are meant for consumption only and will be overwrittenjupytext --execute --to notebook ./doc/demo/*.py
thenjupytext --execute --to notebook ./doc/code/*.py
pre-commit run jupytext --all-files
Tests
Documentation