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

[r2] docs: pin sphinx-argparse to < 0.5.0 (#3988) #4133

Merged
merged 1 commit into from
Sep 17, 2024

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Sep 16, 2024

Cherry-pick from #3988. The doc on the r2 branch needs a rebuild, but the build failed due to sphinx-argparse.


Pin sphinx-argparse to <0.5.0 due to sphinx-doc/sphinx-argparse#56.

Generated by the task: njzjz-bot/njzjz-bot#7.

Summary by CodeRabbit

Summary by CodeRabbit

  • Chores
    • Updated sphinx-argparse dependency to ensure compatibility by restricting it to versions below 0.5.0.

Pin sphinx-argparse to <0.5.0 due to sphinx-doc/sphinx-argparse#56.

Generated by the task: njzjz-bot/njzjz-bot#7.


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Chores**
- Updated `sphinx-argparse` dependency to ensure compatibility by
restricting it to versions below `0.5.0`.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
Copy link
Contributor

coderabbitai bot commented Sep 16, 2024

Walkthrough

Walkthrough

The pull request introduces a change to the pyproject.toml file, specifically updating the version constraint for the sphinx-argparse dependency. The new constraint restricts the allowable versions to those below 0.5.0, replacing the previous allowance for any version starting from 0.5.0. This adjustment aims to enhance compatibility within the documentation generation process by limiting the use of potentially problematic newer versions.

Changes

File Change Summary
pyproject.toml Modified sphinx-argparse version constraint from >=0.5.0 to <0.5.0

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6dafa50 and 57bf4d3.

Files selected for processing (1)
  • pyproject.toml (1 hunks)
Additional comments not posted (1)
pyproject.toml (1)

92-92: Approve the version constraint change.

The change in the version constraint for sphinx-argparse aligns with the PR objective of addressing the build failure caused by version 0.5.0 or higher. Pinning to a version lower than 0.5.0 is a reasonable temporary solution.

However, it's important to track the resolution of the referenced issue (sphinx-doc/sphinx-argparse#56) and consider updating the version constraint accordingly in the future to benefit from bug fixes, new features, or improvements introduced in the newer versions.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    -- I pushed a fix in commit <commit_id>, please review it.
    -- Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    -- @coderabbitai generate unit testing code for this file.
    -- @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    -- @coderabbitai generate interesting stats about this repository and render them as a table.
    -- @coderabbitai read src/utils.ts and generate unit testing code.
    -- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    -- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@njzjz njzjz marked this pull request as draft September 16, 2024 22:57
@njzjz

This comment has been minimized.

Copy link

codecov bot commented Sep 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 62.75%. Comparing base (6dafa50) to head (57bf4d3).
Report is 1 commits behind head on r2.

❗ There is a different number of reports uploaded between BASE (6dafa50) and HEAD (57bf4d3). Click for more details.

HEAD has 4 uploads less than BASE
Flag BASE (6dafa50) HEAD (57bf4d3)
5 1
Additional details and impacted files
@@             Coverage Diff             @@
##               r2    #4133       +/-   ##
===========================================
- Coverage   81.51%   62.75%   -18.76%     
===========================================
  Files         342      164      -178     
  Lines       33882    19147    -14735     
  Branches     2876     2863       -13     
===========================================
- Hits        27618    12016    -15602     
- Misses       5381     6690     +1309     
+ Partials      883      441      -442     

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

@njzjz njzjz marked this pull request as ready for review September 17, 2024 05:01
@njzjz
Copy link
Member Author

njzjz commented Sep 17, 2024

The purpose of this PR is to fix the RTD build, which looks good to me. I won't resolve other CI failures in this PR.

@njzjz njzjz merged commit 440bb82 into deepmodeling:r2 Sep 17, 2024
41 of 47 checks passed
@njzjz njzjz deleted the r2-3988 branch September 17, 2024 18:00
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