feanil/update docs #22
Merged
+14
−210
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
Contributor
feanil
commented
Jan 5, 2026
feanil
commented
- docs: Remove unnecessary docs.
- build: Remove legacy publishing workflow.
- build: Tag new version on docs changes.
feanil
force-pushed
the
feanil/update_docs
branch
3 times, most recently
from
7fbac26 to
928c892
Compare
We generated a more comprehensive README.md which should also be what is presented on PyPI. And we don't need to keep a changelog in the repo. The releases on PyPI will server as the changelog and those are now automatically generated with python-semantic-release.
This repo now uses python-semantic-release and so it doesn't need to publish on tags, this happens automatically in the `release.yml` workflow.
This means we're using setuptools_scm in a very dumb and limited way but it does reduce boilerplate files/code in this repo and that project is fairly stable so I think it's fine. Ideally we either switch to a different build system in the future or the setuptools build interface allows for us to override the version number at build time.
feanil
force-pushed
the
feanil/update_docs
branch
from
928c892 to
e62570c
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #22 +/- ##
=======================================
Coverage 88.23% 88.23%
=======================================
Files 13 13
Lines 408 408
Branches 16 16
=======================================
Hits 360 360
Misses 40 40
Partials 8 8
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.