fix(docs): replace github link for portray with a temporary pypi url #63
Conversation
This file contains 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
|
@philtweir : should this be targeted to a release branch? |
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.
🐛 Bug Fix
Description
Currently, we cannot release (at least to PyPI) as the fork of Portray, and of pdocs, is not packaged. Temporary packages have been created ahead of investigating upstream interest in updates.
To reproduce, pushing a tag to main with a new version leads to a failing build on upload to PyPI.
Root Cause:
As portray and pdocs are abandoned, more recent versions of numpy are incompatible with hug. As a result, we have had to remove hug, which is not critical for our use-case. Functionality in portray (a) is more generally attractive as it integrates mkdocs alos, and (b) project-level issues with pdoc and pdoc3 mean these will not be accepted as dependencies, and pdocs is the only universally-acceptable feature-equivalent alternative.
Testing:
Tried installing this locally, with no issues.
Checklist
Who can review?
List any maintainers or contributors who are best suited to review this pull request.
@KamenDimitrov97 @elleryames