docs: update README Python prereqs; add dev guides for bumping Python and SymPy (#571)#572
Conversation
utensil
left a comment
utensil
left a comment
There was a problem hiding this comment.
Thanks for this — the doc is well-organized and the version policy is clearly stated.
There's a merge conflict in the making between this PR and #574: both add a "Developer guides" toctree block to doc/index.rst starting from the same base on master. If they merge independently Sphinx will produce two separate "Developer guides" sections in the sidebar. Whichever merges second should rebase and consolidate both into a single toctree block.
setup.py still has python_requires='>=3.6' and classifiers only up to 3.11, so the PyPI version badge won't reflect 3.12 until that's updated. Worth doing in this PR since the README already claims 3.10-3.12 support.
test_requirements.txt is missing from the files-to-update table — adding packaging there was part of the 3.12 bump (needed to replace distutils), so it belongs in the checklist.
- Remove Developer guides toctree from doc/index.rst; pygae#574 owns it with the full three-entry block to avoid duplicate sidebar sections - Fix setup.py: python_requires>=3.10, drop 3.8/3.9 classifiers, add 3.12 - Add test_requirements.txt to the files-to-update table in bumping-python.md
- Remove Developer guides toctree from doc/index.rst; pygae#574 owns it with the full three-entry block to avoid duplicate sidebar sections - Fix setup.py: python_requires>=3.10, drop 3.8/3.9 classifiers, add 3.12 - Add test_requirements.txt to the files-to-update table in bumping-python.md
utiberious
force-pushed
the
fix/issue-571-python-docs
branch
from
27c455c to
a5d9b83
Compare
- Remove version policy cross-reference to bumping-sympy.md - Inline the full tracking issue pattern description instead of deferring to bumping-sympy.md - Use bare flake8/pytest to match CI
* docs: add 0.6.1 changelog entries Covers: Mlt component-expression constructor (#578/#580), is_blade null fix (#537), Macdonald PDF update (#577), dev guides (#572/#574), SymPy 1.13 notebook refresh (#570), Lt ImmutableDenseMatrix fix (#569), Python 3.10-3.12 CI (#565). * docs(changelog): fix is_blade entry reference from issue to PR The is_blade entry incorrectly referenced issue 537 but should reference PR 582 to match the convention used in other entries. --------- Co-authored-by: utiberious <utiberious@users.noreply.github.com>
2 participants
Closes #571.
Changes
README.mdPython >= 3.8→>= 3.10 (3.10, 3.11, 3.12 tested via CI)setup.pypython_requiresbumped to>=3.10doc/dev/bumping-python.md(new)Covers: version policy (drop EOL, add recent-but-not-latest), files to update (including
test_requirements.txt), CI action version audit, Python 3.12 compat audit (distutils, escape sequences), local testing setup, and the tracking issue pattern.The doc uses
.mdfor content with a thin.rstmdincludewrapper for Sphinx, consistent with existing practice.