Add sphinx_copybutton to code-blocks #4530
Conversation
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
WalkthroughThe pull request introduces the Changes
Sequence DiagramsequenceDiagram
participant User
participant Documentation
participant CopyButton
User->>Documentation: View documentation
Documentation->>CopyButton: Render copy button
User->>CopyButton: Click copy button
CopyButton->>User: Copy code snippet to clipboard
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
conf.py (1)
Line range hint
214-214: Consider narrowing down the linkcheck ignore patterns.The current patterns (
r"https://github.com/.*"andr"https://discord.gg/.*") will ignore ALL GitHub and Discord links during link checking. This might hide broken links to important resources.Consider:
- Limiting GitHub ignores to specific paths or organizations
- Only ignoring Discord invite links that are known to expire
Example of more specific patterns:
-linkcheck_ignore = [r"https://github.com/.*", r"https://discord.gg/.*"] +linkcheck_ignore = [ + r"https://github.com/esphome/.*", # Only ignore esphome org links + r"https://discord.gg/KhAMKrd", # Only ignore specific Discord invite +]
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
conf.py(1 hunks)requirements.txt(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- requirements.txt
🧰 Additional context used
📓 Path-based instructions (1)
conf.py (1)
Pattern **: - Do not generate or add any sequence diagrams
🔇 Additional comments (2)
conf.py (2)
Line range hint 82-85: LGTM! Version numbers are consistent.
The version (2024.12) and release (2024.12.2) numbers are properly updated and follow the expected format.
48-48: LGTM! Verify sphinx-copybutton dependency.
The extension is correctly added to the configuration.
Let's verify the dependency is properly declared:
✅ Verification successful
Extension and dependency properly configured
The sphinx-copybutton extension is correctly added to the configuration and its dependency is properly declared in requirements.txt with version 0.5.2.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if sphinx-copybutton is declared in requirements.txt
rg -l "sphinx-copybutton" "requirements.txt"
Length of output: 59
Script:
#!/bin/bash
# Check the actual declaration of sphinx-copybutton in requirements.txt
rg "sphinx-copybutton" requirements.txt
Length of output: 64
Add sphinx_copybutton to code-blocks
Description:
Add sphinx_copybutton to code-blocks
Source: https://sphinx-copybutton.readthedocs.io/en/latest/
Related issue (if applicable): fixes NONE
Pull request in esphome with YAML changes (if applicable): esphome/esphome# NONE
Checklist:
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/index.rstwhen creating new documents for new components or cookbook.