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

Add Sphinx collapsible and tab plugins #4225

Merged
merged 59 commits into from
Oct 21, 2024

Conversation

nkinnan
Copy link
Contributor

@nkinnan nkinnan commented Sep 4, 2024

Description:

Add sphinx plugins to make writing better documentation possible.

I'm actually doing this PR to help out shvm who wants to use collapsibles in his documentation RST, but it's a feature I'd like to use in the near future as well. Thus, there's no actual documentation updates in this PR, it's just a build system configuration update to allow use of new Sphinx plugins with support for collapsibles, tabs, and some other features that allow generation of better documentation html for esphome.io. An "infrastructure" PR basically.

Figuring out the dependency / version web was quite tedious, but versions continue to be hard-coded so nothing will break in the future.

Related issue (if applicable): fixes

Pull request in esphome with YAML changes (if applicable): esphome/esphome#

Checklist:

  • I am merging into next because this is new documentation that has a matching pull-request in esphome as linked above.
    or

  • I am merging into current because 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.rst when creating new documents for new components or cookbook.

Copy link
Contributor

coderabbitai bot commented Sep 4, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes involve modifications to the conf.py file for Sphinx documentation configuration in the ESPHome project. Two new Sphinx extensions, "sphinx_tabs.tabs" and "sphinx_toolbox.collapse", have been added to enhance documentation features. The project version has been updated to "2024.10" and the release version to "2024.10.0". Additionally, the linkcheck_ignore list has been updated to ignore links to GitHub and Discord during link checking. These changes are primarily focused on improving documentation capabilities without altering any code logic or control flow.

Changes

Files Change Summary
conf.py Added new Sphinx extensions: sphinx_tabs.tabs, sphinx_toolbox.collapse. Updated version to 2024.10 and release to 2024.10.0. Modified linkcheck_ignore to include patterns for GitHub and Discord links.

Possibly related PRs

  • bump sphinx #4264: The PR updates the Sphinx version, which is directly related to the enhancements made in the main PR that introduces new Sphinx extensions for documentation.

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 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.

Copy link

netlify bot commented Sep 4, 2024

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 15cfe0c
🔍 Latest deploy log https://app.netlify.com/sites/esphome/deploys/66d8f25d07e5b30008fee0f1
😎 Deploy Preview https://deploy-preview-4225--esphome.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (4)
conf.py (1)

44-45: LGTM! Great addition to enhance documentation capabilities.

The addition of "sphinx_tabs.tabs" and "sphinx_toolbox.collapse" extensions aligns perfectly with the PR objectives. These new plugins will enable the use of collapsible sections and tabs in the documentation, which can significantly improve the readability and organization of the HTML output for esphome.io.

Consider documenting the usage of these new extensions in your project's documentation guidelines to ensure consistent application across the documentation.

index.rst (3)

17-23: New section added for demonstration purposes.

This section is clearly marked as "REMOVE BEFORE MERGE" and contains examples of new Sphinx extensions. It's appropriate for testing and documentation but should not be included in the final merge.

Remember to remove this entire section, including the "REMOVE BEFORE MERGE" comments, before finalizing the PR.


60-212: Tabbed content examples added successfully.

The tabbed content examples have been implemented correctly using the Sphinx tabs extension. They showcase:

  • Basic tabs
  • Nested tabs
  • Grouped tabs
  • Code tabs with syntax highlighting

The syntax is correct and the examples are well-structured, providing a good demonstration of the feature's capabilities.

Consider adding a brief explanation or comment above each tabbed example to clarify its purpose or use case. This would enhance the documentation's educational value.


213-220: Reminder to remove example section.

This is another clear marker to remove the entire example section before merging.

Ensure that this section, along with all the examples between the "REMOVE BEFORE MERGE" comments, is deleted before the final merge.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between fd42685 and 28fd7ce.

📒 Files selected for processing (2)
  • conf.py (1 hunks)
  • index.rst (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
conf.py (1)

Pattern **: - Do not generate or add any sequence diagrams

index.rst (1)

Pattern **: - Do not generate or add any sequence diagrams

🔇 Additional comments (1)
index.rst (1)

24-59: Collapsible sections added successfully.

The collapsible sections have been implemented correctly using the Sphinx collapse extension. They demonstrate various use cases including:

  • Basic collapsible sections
  • Custom labels and classes
  • Nested collapsible sections
  • Sections open by default

The syntax is correct and consistent throughout the examples.

index.rst Outdated Show resolved Hide resolved
@jesserockz jesserockz changed the title Add sphinx plugins Bump sphinx to 7.1.2 and add new plugins Oct 21, 2024
@jesserockz jesserockz changed the title Bump sphinx to 7.1.2 and add new plugins Add Sphinx collapsible and tab plugins Oct 21, 2024
@jesserockz jesserockz enabled auto-merge (squash) October 21, 2024 04:25
@jesserockz jesserockz merged commit 4d329c6 into esphome:current Oct 21, 2024
1 of 3 checks passed
@jesserockz jesserockz mentioned this pull request Oct 22, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Oct 23, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants