solve warinings and remove legacy packages - #1013
Open
caioishikawa wants to merge 3 commits into
Open
Conversation
caioishikawa
marked this pull request as ready for review
July 30, 2026 04:24
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request makes several improvements to documentation, project configuration, and code comments for clarity and modernization. The most significant changes include migrating the documentation system from reStructuredText (RST) to Markdown (MD) using MyST, updating the project configuration to the modern PEP 621
pyproject.tomlformat, and cleaning up or removing outdated documentation files and code. Below are the most important changes grouped by theme:Documentation System Modernization:
Migrated Sphinx documentation from RST to Markdown using the MyST parser, replacing
recommonmarkandnbsphinxwithmyst-parser, and removing old Markdown-to-RST conversion logic fromconf.pyandbuild_release_notes.py. The documentation build now directly supports.mdfiles, and the contributing guide and release notes are handled as Markdown. [1] [2] [3] [4] [5]Updated and improved formatting in multiple documentation files for clarity and consistency, such as fixing section underlines, code block formatting, and clarifying docstrings and usage notes. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13]
Project Configuration Updates:
[tool.poetry]format to the PEP 621[project]section inpyproject.toml, explicitly listing dependencies, scripts, and optional documentation dependencies. Python version requirement is now>=3.11,<3.13. [1] [2]Documentation Cleanup and Removal:
docs/source/developer/corrections.rstand thestrax.correctionsAPI documentation section from the reference docs, likely due to outdated or redundant content. [1] [2]Contribution Guidelines Update:
CONTRIBUTING.mdfor readability, using proper Markdown heading levels. [1] [2] [3]Other Minor Improvements:
These changes collectively modernize the documentation workflow, clarify contribution and usage instructions, and update project configuration for better maintainability and clarity.