docs: Allow to use newer release of build docs dependencies

[Czaki]

Summary by CodeRabbit

• Documentation
  • Updated documentation build process to support Python 3.11 and Ubuntu 22.04.
  • Improved documentation dependencies for better compatibility and performance.

[coderabbitai]

Important

Auto Review Skipped

Review was skipped due to path filters

Files ignored due to path filters (1)

• azure-pipelines.yml is excluded by: !**/*.yml

Walkthrough

The project has been updated to accommodate Python 3.11, involving workflow modifications for dependency compilation and adjustments in documentation build settings. The changes include specifying new compile options, updating the operating system for documentation builds to Ubuntu 22.04, and introducing a constraints file tailored for Python 3.11 to manage package versions.

Changes

File Path	Change Summary
.github/workflows/upgrade-dependencies.yml	Added command to compile Python 3.11 dependencies with specific options and extras.
.readthedocs.yml	Updated OS to ubuntu-22.04, Python version to 3.11, modified Python requirements to use constraints_py3.11_docs.txt, and added an extra requirement for docs.
requirements/constraints_py3.11_docs.txt	Autogenerated constraints file for Python 3.11 packages.
requirements/version_denylist.txt	Added packages to the denylist: sphinxcontrib-applehelp, sphinxcontrib-devhelp, sphinxcontrib-htmlhelp, sphinxcontrib-qthelp, and sphinxcontrib-serializinghtml.

🐇✨
In code burrows deep and wide,
A Python leap to 3.11's side.
Docs and workflows in harmonious stride,
The rabbit's craft, our project's pride. 🎉📚

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>.
  • Generate unit-tests for this file.
• 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 tests 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 generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 41ffcfe and 904dd63.

Files ignored due to path filters (1)

• setup.cfg is excluded by: !**/*.cfg

Files selected for processing (3)

• .github/workflows/upgrade-dependencies.yml (1 hunks)
• .readthedocs.yml (1 hunks)
• requirements/constraints_py3.11_docs.txt (1 hunks)

Additional comments: 5

.readthedocs.yml (3)

• 20-20: The operating system has been updated to ubuntu-22.04.
• 22-22: The Python version has been updated to 3.11.
• 28-32: The Python requirements have been updated to use constraints_py3.11_docs.txt and an extra requirement for docs has been added.

.github/workflows/upgrade-dependencies.yml (1)

• 56-56: A new command has been added to compile Python dependencies for version 3.11 with specific options and extras for documentation.

requirements/constraints_py3.11_docs.txt (1)

• 1-481: The constraints file constraints_py3.11_docs.txt has been generated with Python 3.11 and includes a comprehensive list of dependencies with pinned versions.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 904dd63 and 4cea553.

Files selected for processing (2)

• requirements/constraints_py3.11_docs.txt (1 hunks)
• requirements/version_denylist.txt (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• requirements/constraints_py3.11_docs.txt

Additional comments: 1

requirements/version_denylist.txt (1)

• 11-15: The additions to the denylist for sphinxcontrib-* packages seem appropriate given the context of the file. However, ensure that the specified versions are indeed incompatible or problematic with Python 3.11, as this file's purpose is to prevent installation of these versions.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 4cea553 and 554a162.

Files ignored due to path filters (1)

• tox.ini is excluded by: !**/*.ini

Files selected for processing (2)

• package/PartSeg/common_gui/universal_gui_part.py (1 hunks)
• requirements/constraints_py3.11_docs.txt (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• requirements/constraints_py3.11_docs.txt

Additional comments: 2

package/PartSeg/common_gui/universal_gui_part.py (2)

• 86-86: The type hint for the enum parameter in the EnumComboBox class __init__ method has been removed. Ensure that this change does not affect any other parts of the codebase where type hints are expected or required for static type checking or documentation purposes.
• 86-86: The deprecation warning message in the EnumComboBox class __init__ method has been updated to suggest using superqt.QEnumComboBox instead. Confirm that this message is clear and that the suggested alternative is indeed the preferred option. Also, ensure that there is a migration path or documentation available for users to transition to the new class.

[sonarcloud]

Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud