docs: add sphinx.configuration to .readthedocs.yml

[njzjz]

See https://about.readthedocs.com/blog/2024/12/deprecate-config-files-without-sphinx-or-mkdocs-config/

Summary by CodeRabbit

• Documentation
  • Updated Read the Docs configuration to specify Sphinx documentation configuration file.

Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request modifies the .readthedocs.yml configuration file by adding a new sphinx section that explicitly specifies the Sphinx documentation configuration file location as doc/conf.py. This change provides a clear and direct definition of the Sphinx configuration path for documentation generation, ensuring that Read the Docs uses the correct configuration file when building the project's documentation.

Changes

File	Change Summary
.readthedocs.yml	Added sphinx configuration section with configuration: doc/conf.py

Possibly related PRs

• [r2] docs: pin sphinx-argparse to < 0.5.0 (#3988) #4133: Involves sphinx-argparse dependency, which is related to Sphinx documentation generation process

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 33df869 and 894cbb7.

📒 Files selected for processing (1)

• .readthedocs.yml (1 hunks)

🔇 Additional comments (1)

.readthedocs.yml (1)

13-14: LGTM! Change aligns with Read the Docs requirements.

The addition of sphinx.configuration directive complies with Read the Docs' deprecation notice and explicitly defines the Sphinx configuration file location.

Let's verify the existence and location of the Sphinx configuration file:

✅ Verification successful

Path verification successful: doc/conf.py exists and is correctly referenced

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the existence of Sphinx configuration file and check for potential path issues

# Check if the specified conf.py exists
if [ -f "doc/conf.py" ]; then
    echo "✓ doc/conf.py exists"
else
    echo "✗ doc/conf.py not found"
    # Check if it might be in a 'docs' directory instead
    if [ -f "docs/conf.py" ]; then
        echo "! Found conf.py in 'docs/' instead of 'doc/'"
    fi
fi

# Check for any other conf.py files to ensure we're using the correct one
fd "conf.py$"

Length of output: 103

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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. (Beta)
• @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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.61%. Comparing base (65ca05a) to head (894cbb7).
Report is 2 commits behind head on devel.

Additional details and impacted files

@@            Coverage Diff             @@
##            devel    #4553      +/-   ##
==========================================
+ Coverage   84.57%   84.61%   +0.03%     
==========================================
  Files         677      680       +3     
  Lines       63916    64466     +550     
  Branches     3486     3539      +53     
==========================================
+ Hits        54060    54545     +485     
- Misses       8730     8780      +50     
- Partials     1126     1141      +15     

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