Installation & Docs Updates - #239
Merged
Merged
Conversation
…po, and introduced tests/ is small enough to not need large file storage lfs). It was causing lfs issues during repo cloning.
…ed sphinx (theme required for readthedocs) to pyproject.toml
There was a problem hiding this comment.
Pull request overview
This PR modernizes xpore’s packaging and documentation setup to support clean installs and ReadTheDocs builds by migrating from legacy setup.py packaging to a PEP 517/518 pyproject.toml configuration and adding an explicit RTD config.
Changes:
- Remove legacy packaging/LFS config (
setup.py, LFS entries in.gitattributes). - Add
pyproject.tomlwith project metadata, dependencies, console script entry point, and dynamic versioning. - Update installation docs and add
.readthedocs.yamlto support RTD builds.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| setup.py | Removed legacy setuptools-based installer in favor of pyproject.toml. |
| pyproject.toml | New PEP 621/517 packaging configuration (metadata, deps, scripts, dynamic version). |
| docs/source/installation.rst | Updates install instructions to pip install .. |
| .readthedocs.yaml | Adds RTD configuration to build docs with pip install + docs extras. |
| .gitattributes | Removes LFS tracking rules that are no longer needed. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
jonathangoeke
approved these changes
Jul 29, 2026
ch99l
approved these changes
Jul 30, 2026
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.
Various updates required for clean install & to update the ReadTheDocs:
Changes:
setup.pytopyproject.toml(setup.py is deprecated) & updated doc reference (python setup.py install to pip install .).readthedocs.yaml-> since Jan 2025 ReadTheDocs requires a config file, so added this.Verification: