packaging: Pinned docs dependencies and use PEP 735 for them

[edgarrmondragon]

Summary by Sourcery

This pull request updates the documentation build process to use a requirements.txt file for installing dependencies, generated from the docs dependency group in pyproject.toml. This change leverages PEP 735 for improved dependency management and ensures consistent documentation builds across different environments.

Build:

• Migrate documentation dependencies to a dedicated docs dependency group in pyproject.toml, leveraging PEP 735 for improved dependency management.

CI:

• Update pre-commit configuration to export documentation dependencies to a requirements.txt file, ensuring consistent dependency installation for documentation builds.

Documentation:

• Use a requirements.txt file to install documentation dependencies, ensuring consistent and reproducible documentation builds.

Chores:

• Remove the uv.lock file and update .gitignore to exclude it, as uv is no longer directly managing the dependencies.

---

📚 Documentation preview 📚: https://meltano-sdk--2883.org.readthedocs.build/en/2883/

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request migrates the documentation dependencies to a dedicated dependency group, manages them using PEP 735, and adds a uv badge to the README.

Flow diagram for documentation build process

graph LR
  A[Update pyproject.toml with docs dependencies] --> B{Run pre-commit hook: uv-export}
  B -- Generates --> C[docs/requirements.txt]
  C --> D[Readthedocs build process]
  D -- Installs dependencies from --> C
  D --> E[Documentation is built]

Loading

File-Level Changes

Change	Details	Files
Migrated documentation dependencies to a dedicated dependency group and managed them using PEP 735.	Moved documentation dependencies from project.optional-dependencies to dependency-groups.docs in pyproject.toml. Added docs and typing to the dev dependency group. Created a docs/requirements.txt file to list the documentation dependencies. Configured .pre-commit-config.yaml to export documentation dependencies to docs/requirements.txt using uv-export. Updated .readthedocs.yml to install documentation dependencies from docs/requirements.txt.	pyproject.toml .readthedocs.yml .pre-commit-config.yaml docs/requirements.txt
Added a uv badge to the README.	Added a uv badge to the README.md file.	README.md
Added uv.lock to .gitignore.	Added uv.lock to .gitignore.	.gitignore

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @edgarrmondragon - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider adding a comment explaining why the docs dependencies were moved from project.optional-dependencies to dependency-groups.
• It might be helpful to add a short description of what PEP 735 is in the commit message.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[codspeed-hq]

CodSpeed Performance Report

Merging #2883 will not alter performance

_{Comparing edgarrmondragon/docs/pin-docs-deps (e28d778) with main (38a5ab9)}

Summary

✅ 7 untouched benchmarks

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.33%. Comparing base (38a5ab9) to head (e28d778).
Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2883   +/-   ##
=======================================
  Coverage   91.33%   91.33%           
=======================================
  Files          62       62           
  Lines        5203     5203           
  Branches      675      675           
=======================================
  Hits         4752     4752           
  Misses        319      319           
  Partials      132      132           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.