Skip to content

Conversation

@matthewryanscott
Copy link
Contributor

@matthewryanscott matthewryanscott commented Feb 28, 2025

The readthedocs config was broken. This fixes it. 😄

@sourcery-ai
Copy link

sourcery-ai bot commented Feb 28, 2025

Reviewer's Guide by Sourcery

This pull request focuses on improving the documentation generation process. It consolidates documentation dependencies, updates the Python version used for building documentation, and includes minor configuration adjustments. Additionally, it adds a .gitignore file to the docs directory and updates the uv.lock file.

Updated class diagram for pyproject.toml dependencies

classDiagram
    class pyproject.toml {
        -buffered: list
        -tools: list
        -dev: list
        +docs: list
    }
    note for pyproject.toml "Consolidated documentation dependencies into a single 'docs' group."
Loading

File-Level Changes

Change Details Files
Consolidated documentation dependencies and updated the Python version for documentation builds.
  • Moved documentation dependencies from the dev group to a dedicated docs group in pyproject.toml.
  • Specified Python 3.13 for documentation builds in .readthedocs.yml.
  • Removed the version: 3.9 specification from the readthedocs.yml file.
pyproject.toml
.readthedocs.yml
Removed an unnecessary intersphinx mapping.
  • Commented out the intersphinx mapping in docs/conf.py.
docs/conf.py
Added a .gitignore file to the docs directory.
  • Added a .gitignore file to the docs directory.
docs/.gitignore
Updated the uv.lock file.
  • Updated the uv.lock file.
uv.lock

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

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

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

Overall Comments:

  • Consider using a tool like sphinx-apidoc to automatically generate API documentation from your Python code.
  • It might be helpful to add a .gitignore file to the root directory to prevent committing files like uv.lock.
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 ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@matthewryanscott matthewryanscott merged commit cce86a7 into master Feb 28, 2025
6 checks passed
@matthewryanscott matthewryanscott deleted the fix-docs branch February 28, 2025 04:20
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.

2 participants