standardize formatting and other improvements #70
Conversation
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
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
This commit introduces several improvements to the repository:
- Converted all Jupyter notebooks (.ipynb) to Markdown (.md) for better readability, diffing, and accessibility.
- Updated links in the main README.md to point to the new Markdown files.
- Fixed a broken internal link in designing_twitter.md.
- Removed placeholder content and extraneous empty code blocks left over from notebook conversions. Addressed potentially missing content by notifying you.
- Standardized Markdown formatting across all documents, including heading levels and list structures. Verified all image links.
- Simplified requirements.txt to retain only essential packages for the ipynb_tests.yml workflow (pytest, nbval, and their core dependencies).
- Updated the .github/workflows/ipynb_tests.yml workflow:
- Removed a redundant pip install for pytest and nbval (now in requirements.txt).
- Changed the Python version from 3.7 to 3.11 to resolve build issues and use a more current version.
- Ensured the .github/workflows/action.yml (Markdown link checker) remains active.
This commit adds back the `pip install pytest nbval` line to the `.github/workflows/ipynb_tests.yml` file. This change is based on your feedback to ensure that these packages are explicitly installed immediately before the `pytest --nbval` command is run, as a safeguard for the CI build process. This reverts a previous change that relied solely on `requirements.txt` for these packages to be available in the execution path for the testing step.
This commit introduces significant updates to the CI setup:
1. Replaced the `.github/workflows/ipynb_tests.yml` workflow with a modern version:
- Implements a matrix testing strategy for Python versions 3.9, 3.10, and 3.11.
- Updates `actions/checkout` to `v4`.
- Updates `actions/setup-python` to `v5` and enables pip caching for faster dependency installation.
- Relies on `requirements.txt` for `pytest` and `nbval` installation.
2. Updated `requirements.txt`:
- Removed pinned versions for all dependencies (e.g., `pytest`, `nbval`, `six`, `python-dateutil`) to allow pip to install the latest compatible versions.
These changes aim to improve the robustness, speed, and maintainability of the CI process for testing notebooks.
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.
No description provided.