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.

Sign up for GitHub

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

Jump to bottom

Documentation: Migrate to Furo theme #558

Closed
wants to merge 3 commits into from
Closed

Documentation: Migrate to Furo theme #558

wants to merge 3 commits into from

Conversation

amotl
Copy link
Collaborator

@amotl amotl commented Oct 27, 2024 •
edited
Loading

About

I don't know if you are going to stick with the Alabaster theme forever, but looking at WhiteNoise for example, but also many other projects, this patch is giving it a shot for Responder as well to render its documentation using the Furo theme for Sphinx.

Status

This patch does not have any priority, needs additional work, and is just here to probe interests.

Thoughts

What do you think about it, @kennethreitz?

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Oct 27, 2024

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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.

@amotl amotl added qa and testing Quality assurance and software testing feature New feature or request question Further information is requested needs BDFL approval documentation Documentation: Content and Infrastructure and removed qa and testing Quality assurance and software testing feature New feature or request labels Oct 27, 2024
@amotl amotl mentioned this pull request Oct 27, 2024
Merged
Base automatically changed from ci-docs to main October 27, 2024 17:13
amotl added 3 commits October 27, 2024 18:14
@amotl
Documentation: Badges, linking, wording, inline comments. This and that.
ca928be 
A few of the adjustments here have been required to mitigate Sphinx
warnings, which would converge to errors on CI, thus failing the build.

A few other changes, both wording and syntax/formatting fixes, are
coming from regular copyediting and documentation maintenance.
@amotl
Documentation: Migrate to Furo theme
a793c52
@amotl
Documentation: Add Sphinx extensions "copybutton" and "opengraph"
1750d02
@amotl amotl changed the title Documentation: Migrate to Furo theme. Add Sphinx extensions "copybutton" and "opengraph". Documentation: Migrate to Furo theme Oct 28, 2024
@amotl
Copy link
Collaborator Author

amotl commented Oct 29, 2024

@kennethreitz said:

My only request is keeping alabaster and being cautious with switching to markdown.

In this spirit, let's close this PR again. 🌻

@amotl amotl closed this Oct 29, 2024
@amotl amotl deleted the docs-furo branch October 29, 2024 21:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation Documentation: Content and Infrastructure needs BDFL approval question Further information is requested
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@amotl