Modernize packaging/CI and overhaul docs for RTD rendering and CIGAR guidance#1
Open
JudoWill wants to merge 11 commits into
Open
Modernize packaging/CI and overhaul docs for RTD rendering and CIGAR guidance#1JudoWill wants to merge 11 commits into
JudoWill wants to merge 11 commits into
Conversation
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.
Title
Modernize packaging/CI and overhaul docs for RTD rendering and CIGAR guidance
Summary
pyproject.toml, removing legacysetup.py, and updating development requirements..github/workflows/ci.yml,.readthedocs.yaml, Sphinx config/requirements) for current Python and Read the Docs workflows.usageguide and a new dedicated CIGAR format explainer page.3.8-3.12) to match project classifiers.Commits Included (main...publish-prep)
7bde62dmodernizing4655d0dfixing docs for fixed width setup58b00cdfixes for sphinx warnings0f75594unpinning141913apointing at correct repo33f2080adding cigar explanation and basic usage491f8f3updating old tox032dd86flake8 massive fixca3b059configuration updatesddbd9ealate flake8sf72c0c2resolved rearrangement docsNotable Changes by Area
Packaging and metadata
pyproject.tomlwith project metadata and dependency groups.setup.py.requirements_dev.txt.cigarmath/__init__.py.CI and release/doc infrastructure
.github/workflows/ci.yml..readthedocs.yaml.tox.inienv matrix topy38, py39, py310, py311, py312, flake8.Documentation structure and quality
docs/api.rst,docs/installation.rst,docs/readme.rst,docs/history.rst,docs/index.rst.docs/cigar.rst.docs/usage.rstinto a workflow-based guide with runnable examples and expected outputs.docs/requirements.txt.docs/conf.pyfor stable rendering and warning cleanup.API docstring rendering fixes
cigarmath/block.pycigarmath/cigarmath.pycigarmath/clipping.pycigarmath/inference.pycigarmath/mapping.pycigarmath/iterators.pycigarmath/combine.pycigarmath/pileup.pycigarmath/conversions.pyLint and style sweep
flake8cleanup acrosscigarmath/andtests/.cigarmath/__init__.py) and module imports..ipynb_checkpointsexcluded / cleaned).Diff Scope
Risk / Reviewer Notes
pyproject.toml)