Release 1.0 - #64
Open
Josef-Haupt wants to merge 6 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR prepares the repository for the 1.0.0 release by bumping the package version and aligning the public-facing documentation (README + Sphinx docs) with the current model/backends and usage examples.
Changes:
- Bump package version to
1.0.0and update related project metadata links. - Refresh README/docs to reflect V2.4 vs V3.0 capabilities (including ONNX geo backend) and updated usage snippets.
- Improve docs versioning by reading
releasefrompyproject.tomlin Sphinx config.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Updates feature bullets and benchmark table formatting/content. |
| pyproject.toml | Bumps version to 1.0.0 and adjusts project metadata entries. |
| docs/setup.rst | Updates environment naming and makes wheel filename examples version-agnostic. |
| docs/quick_start.rst | Updates example output calls and custom species list filename; clarifies geo backends. |
| docs/models.rst | Documents ONNX backend availability for geo model v3.0 and notes lack of PyTorch geo backend. |
| docs/general.rst | Fixes section underline formatting for proper reST rendering. |
| docs/conf.py | Reads documentation release directly from pyproject.toml and switches docstring parsing to napoleon. |
| CHANGELOG.md | Refines wording of unreleased entries but does not yet add a 1.0.0 section header. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
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.
No description provided.