Skip to content

Conversation

@enryH
Copy link
Collaborator

@enryH enryH commented Nov 24, 2025

This pull request updates documentation and configuration files to improve clarity and keep the project up to date with newer tools and environments. The most notable changes are updates to the CI/CD documentation to reflect additional formatting checks, an upgrade of the build environment in the Read the Docs configuration, and a minor clarification in the docs build instructions.

Documentation and configuration updates:

  • Updated .github/workflows/README.md to indicate that both black and isort are now used for formatting checks, not just black.
  • Upgraded the Read the Docs build environment in .readthedocs.yaml to use Ubuntu 24.04 and Python 3.13, ensuring compatibility with newer dependencies and features.
  • Added a minor formatting improvement in docs/README.md for the documentation build options section, clarifying the use of the --separate option.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates documentation formatting and configuration files to modernize the build environment and improve documentation clarity. The changes ensure Read the Docs uses up-to-date infrastructure while also cleaning up markdown formatting issues in the documentation files.

  • Upgraded Read the Docs build environment to Ubuntu 24.04 and Python 3.13
  • Updated CI/CD documentation to accurately reflect that both black and isort are used for formatting checks
  • Improved markdown formatting in docs build instructions by fixing list indentation and removing trailing whitespace

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
.readthedocs.yaml Upgraded build environment to Ubuntu 24.04 and Python 3.13 for improved compatibility with modern dependencies
.github/workflows/README.md Updated documentation to mention both black and isort as formatting tools, matching the actual CI workflow
docs/README.md Fixed markdown formatting by removing trailing whitespace and correcting list item indentation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@enryH enryH merged commit 7b5ddae into main Nov 24, 2025
18 checks passed
@enryH enryH deleted the increase_rtd_and_memo branch November 24, 2025 12:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants