[pull] master from squidfunk:master

[pull]

See Commits and Changes for more details.

---

Created by pull[bot] (v2.0.0-alpha.1)

Can you help keep this open source service alive? 💖 Please sponsor : )

Summary by Sourcery

This pull request includes bug fixes for the privacy plugin and tag listing, enhances the instant previews configuration, updates documentation, and bumps the version to 9.6.5.

Bug Fixes:

• Fixes a crash in the privacy plugin that occurs when an HTTP download fails.
• Fixes an issue where tags listing was not showing when the file name had spaces.

Enhancements:

• Adds a timeout to HTTP requests in the privacy plugin to prevent indefinite hanging.
• Improves the configuration of instant previews, allowing for more precise control over where they are shown by defining multiple items under the configurations setting.

Build:

• Updates the cache path and adds a note about caching in the documentation.

Documentation:

• Updates documentation to reflect changes to instant previews configuration.
• Updates documentation to reflect changes to caching.

Chores:

• Updates the version number to 9.6.5.

[gitstream-cm]

🚨 gitStream Monthly Automation Limit Reached 🚨

Your organization has exceeded the number of pull requests allowed for automation with gitStream.
Monthly PRs automated: 1741/250

To continue automating your PR workflows and unlock additional features, please contact LinearB.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request includes several fixes and improvements. It adds a timeout to HTTP requests in the privacy plugin, updates the configuration of the preview extension, clarifies caching, fixes a bug in the privacy plugin, and updates the theme version.

Sequence diagram for handling HTTP request timeout in Privacy Plugin

sequenceDiagram
  participant P as Privacy Plugin
  participant R as requests.get()
  participant S as External Server

  P->>R: requests.get(file.url, timeout=DEFAULT_TIMEOUT_IN_SECS)
  activate R
  alt Successful Response
    R->>S: GET file.url
    activate S
    S-->>R: Response (status 200)
    deactivate S
    R-->>P: Response object
    P->>P: Process response
  else Connection Error or HTTP Error
    R-->>P: Exception (ConnectionError or HTTPError)
    P->>P: log.warning(f"Couldn't retrieve {file.url}: {error}")
    P-->>P: return None
  end
  deactivate R

Loading

Updated class diagram for Privacy Plugin's _fetch method

classDiagram
  class PrivacyPlugin {
    _fetch(file: File, config: MkDocsConfig)
  }
  class File {
    url: URL
  }
  class MkDocsConfig {
  }
  PrivacyPlugin -- File : uses
  PrivacyPlugin -- MkDocsConfig : uses
  note for PrivacyPlugin "Added timeout and error handling to requests.get()"

Loading

File-Level Changes

Change	Details	Files
Added a timeout to HTTP requests in the privacy plugin to prevent indefinite hanging.	Introduced DEFAULT_TIMEOUT_IN_SECS constant. Added a timeout parameter to the requests.get call. Added a try-except block to catch connection errors and log warnings.	material/plugins/privacy/plugin.py src/plugins/privacy/plugin.py
Updated the configuration of the material.extensions.preview Markdown extension to use a configurations setting.	Replaced targets and sources with configurations. Updated documentation to reflect the new configuration structure.	docs/setup/setting-up-navigation.md
Clarified the use of caching in Material for MkDocs plugins and updated related documentation.	Added a note about caching in the publishing-your-site.md document. Added a link to the plugins/requirements/caching.md page. Updated the explanation of the cache directory in the example workflows.	docs/publishing-your-site.md
Fixed a bug in the privacy plugin that caused crashes when HTTP downloads failed.	Added a fix to the changelog.	docs/changelog/index.md
Updated the version number of the theme.	Updated the version number in material/__init__.py. Updated the version number in material/templates/base.html. Updated the version number in package.json.	material/__init__.py material/templates/base.html package.json

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[coderabbitai]

Important

Review skipped

Bot user detected.

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

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