Skip to content

fix: remove docs requirements file#10

Merged
gemmadanks merged 3 commits intomainfrom
fix-docs-dependencies
Oct 11, 2025
Merged

fix: remove docs requirements file#10
gemmadanks merged 3 commits intomainfrom
fix-docs-dependencies

Conversation

@gemmadanks
Copy link
Copy Markdown
Owner

@gemmadanks gemmadanks commented Oct 11, 2025

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:

  • I have updated any relevant documentation
  • I have added unit tests for any new code
  • I have linked to any relevant issues
  • I will squash my commits and, where needed, edit the commit messages to make them more informative follow the conventional commits format
  • This pull request is ready to merge (leave unchecked to indicate a WIP)

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:

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.
Copilot AI review requested due to automatic review settings October 11, 2025 13:26
@codecov-commenter
Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.txt to pyproject.toml optional 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.

Comment thread pyproject.toml Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings October 11, 2025 18:23
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@gemmadanks gemmadanks merged commit 38314b9 into main Oct 11, 2025
24 checks passed
@gemmadanks gemmadanks deleted the fix-docs-dependencies branch October 11, 2025 19:09
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.

3 participants