Conversation
Removes requirements file for docs and pre-commit hook that generates it. Uses pyproject.toml optional extras for RTD instead. Prevents dependabot PRs failing checks.
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Pull Request Overview
This PR modernizes documentation dependency management by migrating from a dedicated requirements file to Poetry's optional dependencies feature. This change prevents dependabot PRs from failing due to outdated requirements file generation.
- Moves documentation dependencies from
docs/requirements.txttopyproject.tomloptional dependencies - Updates ReadTheDocs configuration to use pip with extras instead of requirements file
- Removes pre-commit hook that generated the requirements file
Reviewed Changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Updates license format and restructures docs dependencies as optional extras |
| docs/requirements.txt | Removes the entire requirements file (132 lines) |
| README.md | Updates installation command to use --all-extras flag |
| .readthedocs.yaml | Configures RTD to install docs extras instead of requirements file |
| .pre-commit-config.yaml | Removes poetry-export hook that generated requirements file |
| .github/workflows/docs-pages.yaml | Updates workflow to install docs extras |
| .github/workflows/ci.yaml | Updates workflows to install all extras for comprehensive testing |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 7 out of 8 changed files in this pull request and generated no new comments.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Removes requirements file for docs and pre-commit hook that generates it. Uses pyproject.toml optional extras for RTD instead. Prevents dependabot PRs failing checks.
Prerequisites checklist
Please check each of the following before merging:
What is the purpose of this pull request?
Check all that apply:
Documentation update
Bug fix
New feature
Changes to an existing feature
Refactor
Increasing test coverage
Other, please explain: