Skip to content

build(docs): Update dependencies to latest versions.#631

Merged
kirkrodrigues merged 1 commit intoy-scope:mainfrom
kirkrodrigues:update-docs-reqs
Dec 10, 2024
Merged

build(docs): Update dependencies to latest versions.#631
kirkrodrigues merged 1 commit intoy-scope:mainfrom
kirkrodrigues:update-docs-reqs

Conversation

@kirkrodrigues
Copy link
Copy Markdown
Member

@kirkrodrigues kirkrodrigues commented Dec 9, 2024 •
edited by coderabbitai bot
Loading

Description

This updates the docs site's dependencies to the latest versions including unlocking the versions of pydata-sphinx-theme and sphinx since the issues that required us to lock them have been resolved.

Validation performed

task docs:serve rendered and served the site as expected.

Summary by CodeRabbit

  • Chores
    • Updated several documentation dependencies to their latest versions for improved performance and features.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Dec 9, 2024 •
edited
Loading

Walkthrough

The pull request includes updates to the version specifications of several dependencies listed in the docs/requirements.txt file. Notable changes include upgrading myst-parser to >=4.0.0, pydata-sphinx-theme to >=0.16.0, sphinx to >=8.1.3, sphinx_design to >=0.6.1, and sphinxcontrib-mermaid to >=1.0.0. These modifications reflect a shift towards more recent versions of the libraries to potentially leverage new features or fixes.

Changes

File Change Summary
docs/requirements.txt - Updated myst-parser from >=2.0.0 to >=4.0.0
- Updated pydata-sphinx-theme from ==0.14.4 to >=0.16.0
- Updated sphinx from ==8.0.2 to >=8.1.3
- Updated sphinx_design from >=0.5.0 to >=0.6.1
- Updated sphinxcontrib-mermaid from >=0.9.2 to >=1.0.0

Possibly related PRs

Suggested reviewers

  • davemarco
📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7176c5e and 26482c9.

📒 Files selected for processing (1)
  • docs/requirements.txt (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • docs/requirements.txt

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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 generate docstrings to generate docstrings for this PR. (Experiment)
  • @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.

junhaoliao
junhaoliao approved these changes Dec 10, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@junhaoliao junhaoliao left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Validated with below steps:

  1. git lfs fetch -all; git lfs pull to download all image assets.
  2. task docs:serve and loaded http://localhost:8080 in a Microsoft Edge Version 132.0.2957.41 (Official build) stable app, beta channel (64-bit) browser. (Note 127.0.0.1 should not be used in place of localhost where CORS restrictions are lifted; otherwise, the version switcher would fail to load which would cause the theme switcher not to function.)
  3. Tested below functions which worked as expected:
    1. Theme switching.
    2. Searching with keyword "data" and observing the keyword getting highlighted in the results.
    3. Mermaid diagram on http://localhost:8080/dev-guide/tooling-gh-workflows.html rendered as expected. The text is a bit hard to see in the "Light" theme but that's not directly related to this PR.

The PR title is fine to be used as the squashed commit message.

@kirkrodrigues kirkrodrigues merged commit 6dd8fc1 into y-scope:main Dec 10, 2024
@kirkrodrigues kirkrodrigues deleted the update-docs-reqs branch December 10, 2024 22:00
davidlion pushed a commit to Bill-hbrhbr/clp that referenced this pull request Dec 20, 2024
@kirkrodrigues @davidlion
build(docs): Update dependencies to latest versions. (y-scope#631)
42db88c
@coderabbitai coderabbitai bot mentioned this pull request May 20, 2025
Merged
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@junhaoliao junhaoliao junhaoliao approved these changes

+1 more reviewer

@Henry8192 Henry8192 Henry8192 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@kirkrodrigues @junhaoliao @Henry8192