Skip to content

Refactoring Docs to use JupyText#49

Merged
rlundeen2 merged 30 commits intomainfrom
users/rlundeen/2_6_jupytext
Feb 21, 2024
Merged

Refactoring Docs to use JupyText#49
rlundeen2 merged 30 commits intomainfrom
users/rlundeen/2_6_jupytext

Conversation

@rlundeen2
Copy link
Copy Markdown
Contributor

@rlundeen2 rlundeen2 commented Feb 20, 2024

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

  • All documentation should be a .md file or a .py file in the percent format file (this will generate to .ipynb for consumption)
    • Do not update .ipynb files directly. These are meant for consumption only and will be overwritten
  • The code should be able to execute one time in a reasonable timeframe, our goal is to run this in build pipelines
    • Short term, before we have it in our build pipelines, please run it manually with any big changes and check there are no errors
    • Currently, run: jupytext --execute --to notebook ./doc/demo/*.py then jupytext --execute --to notebook ./doc/code/*.py
    • Soon this will be: pre-commit run jupytext --all-files
    • Please do not re-commit updated generated files if nothing has changed

Tests

  • no new tests required
  • new tests added
  • existing tests adjusted

Documentation

  • no documentation changes needed
  • documentation added or edited
  • example notebook added or updated

@github-actions
Copy link
Copy Markdown

github-actions bot commented Feb 20, 2024

Test Results

114 tests  ±0   114 ✅ ±0   14s ⏱️ -1s
  1 suites ±0     0 💤 ±0 
  1 files   ±0     0 ❌ ±0 

Results for commit c32dc81. ± Comparison against base commit 9cfe4c3.

♻️ This comment has been updated with latest results.

Copy link
Copy Markdown
Contributor

@romanlutz romanlutz left a 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!

rlundeen2 and others added 4 commits February 20, 2024 16:45
Co-authored-by: Roman Lutz <romanlutz13@gmail.com>
Co-authored-by: Roman Lutz <romanlutz13@gmail.com>
Co-authored-by: Roman Lutz <romanlutz13@gmail.com>
@rlundeen2 rlundeen2 merged commit 7cd212e into main Feb 21, 2024
@rlundeen2 rlundeen2 deleted the users/rlundeen/2_6_jupytext branch February 21, 2024 03:39
romanlutz added a commit to romanlutz/PyRIT that referenced this pull request Mar 13, 2026
- Bump pypdf >=6.7.5 -> >=6.8.0 (direct dep, fixes microsoft#56)
- Bump gradio >=5.32.0 -> >=6.7.0 (optional dep, fixes microsoft#49-52)
- Add orjson >=3.11.6 constraint (transitive, fixes microsoft#59)
- Add tornado >=6.5.5 constraint (transitive, fixes microsoft#57-58)
- Fix minimatch ReDoS via npm audit fix (fixes microsoft#46-47)
- Add @tootallnate/once >=3.0.1 npm override (fixes microsoft#55)
- diskcache microsoft#30 has no patched version available

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
romanlutz added a commit to romanlutz/PyRIT that referenced this pull request Mar 13, 2026
- Bump pypdf >=6.7.5 -> >=6.8.0 (direct dep, fixes microsoft#56)
- Bump gradio >=5.32.0 -> >=6.7.0 (optional dep, fixes microsoft#49-52)
- Add orjson >=3.11.6 constraint (transitive, fixes microsoft#59)
- Add tornado >=6.5.5 constraint (transitive, fixes microsoft#57-58)
- Fix minimatch ReDoS via npm audit fix (fixes microsoft#46-47)
- Add @tootallnate/once >=3.0.1 npm override (fixes microsoft#55)
- diskcache microsoft#30 has no patched version available

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants