Skip to content
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 30 commits into from
Feb 21, 2024
Merged

Conversation

rlundeen2
Copy link
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

Copy link

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.

.pre-commit-config.yaml Outdated Show resolved Hide resolved
Copy link
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!

doc/README.md Show resolved Hide resolved
doc/README.md Outdated Show resolved Hide resolved
doc/README.md Outdated Show resolved Hide resolved
doc/README.md Outdated Show resolved Hide resolved
doc/README.md Outdated Show resolved Hide resolved
doc/code/orchestrator.pct.py Outdated Show resolved Hide resolved
doc/demo/1_gandalf.pct.py Outdated Show resolved Hide resolved
doc/demo/2_multiturn_strategies.ipynb Outdated Show resolved Hide resolved
doc/setup/setup.md Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
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
7 checks passed
@rlundeen2 rlundeen2 deleted the users/rlundeen/2_6_jupytext branch February 21, 2024 03:39
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.

None yet

4 participants