Update publish and mkdocs workflows

[surajpaib]

Description

Related Issue

Type of Change

• 📚 Examples / docs / tutorials / dependencies update
• 🔧 Bug fix (non-breaking change which fixes an issue)
• 🥂 Improvement (non-breaking change which improves an existing feature)
• 🚀 New feature (non-breaking change which adds functionality)
• 💥 Breaking change (fix or feature that would cause existing functionality to change)
• 🔐 Security fix

Checklist

• I've read the CODE_OF_CONDUCT.md document.
• I've read the CONTRIBUTING.md guide.
• I've updated the code style using make codestyle.
• I've written tests for all new methods and classes that I created.
• I've written the docstring in Google format for all the methods and classes that I used.

Summary by CodeRabbit

• Chores
  • Streamlined the release publishing process by consolidating build and deployment steps, now supporting pre-releases and improved dependency management.
• Documentation
  • Updated the documentation setup to revert to default styling, ensuring a more standardized presentation of content.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request updates two configuration files. The GitHub Actions workflow is modified by reformatting indentation and replacing separate build and publish steps with a consolidated step using JRubics/poetry-publish, which now includes additional parameters. The mkdocs configuration is updated by commenting out the docstring_style option for the mkdocstrings plugin. Both files retain their overall functionality while streamlining the processes defined within them.

Changes

File(s)	Change Summary
.github/workflows/publish.yml	Reformatted indentation; replaced the separate build and publish steps with a single step using JRubics/poetry-publish (with parameters: python_version, pypi_token, allow_poetry_pre_release, ignore_dev_requirements), while keeping the checkout, Python setup, and Poetry installation steps unchanged.
mkdocs.yml	Commented out the docstring_style configuration for the mkdocstrings plugin, leaving filters set to null; the overall structure remains unchanged.

Sequence Diagram(s)

sequenceDiagram
    participant CI as GitHub Actions
    participant Repo as Repository
    participant Publish as JRubics/poetry-publish
    CI->>Repo: Checkout code
    CI->>Repo: Setup Python & Poetry
    CI->>Publish: Execute publishing step\n(with parameters)
    Publish-->>CI: Confirm publish results

Loading

Poem

I'm a rabbit, hopping with cheer,
In workflows streamlined, my code is clear.
Steps now combine in a single leap,
Publishing magic, no more secrets to keep.
Hop along with me in this merry code fête 🐇✨!

Tip

🌐 Web search-backed reviews and chat

• We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
• You can disable this feature by setting web_search: false in the knowledge_base settings.
• Please share any feedback in the Discord discussion.

---

📜 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 db64439 and ea05540.

📒 Files selected for processing (2)

• .github/workflows/publish.yml (1 hunks)
• mkdocs.yml (1 hunks)

---

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.