Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MAINT] change m2r to m2r2 #909

Merged
merged 7 commits into from
Nov 18, 2024
Merged

[MAINT] change m2r to m2r2 #909

merged 7 commits into from
Nov 18, 2024

Conversation

jdkent
Copy link
Member

@jdkent jdkent commented Nov 16, 2024

Closes #795 .

Changes proposed in this pull request:

Summary by Sourcery

Enhancements:

  • Replace m2r with m2r2 in the documentation dependencies to address compatibility issues.

Copy link
Contributor

sourcery-ai bot commented Nov 16, 2024

Reviewer's Guide by Sourcery

This PR updates the documentation dependencies by replacing the m2r package with m2r2 and removing the version constraint on mistune. This is a maintenance change that helps keep the documentation build system up to date.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Update documentation dependencies to use m2r2 instead of m2r
  • Replace m2r with m2r2 in doc dependencies
  • Remove version constraint on mistune package
  • Remove temporary workaround comment for mistune version
setup.cfg

Assessment against linked issues

Issue Objective Addressed Explanation
#795 Replace m2r package with a maintained alternative (either m2r2 or sphinx-mdinclude)
#795 Remove dependency constraint on mistune<2

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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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
Contributor

@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 @jdkent - I've reviewed your changes and they look great!

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.

@jdkent jdkent merged commit d612a7b into neurostuff:main Nov 18, 2024
1 check was pending
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.

Replace m2r with a package that is maintained
1 participant