Repository navigation
Fix source installation instructions and archive link - #298
Open
ryanduguid wants to merge 1 commit into
Open
ryanduguid wants to merge 1 commit into
ryanduguid wants to merge 1 commit 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
1 participant
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.
Summary
The source installation command refers to a
setup.pyfile that is absent, and the GitHub reference has no target. Usepython -m pipfor both installation methods and link source archives to the repository's tags page.Evidence
python setup.py installfails because the file is missing; the Sphinx build reportsUnknown target name: "our github page".After:
make cleanandmake htmlsucceed with Sphinx 9.1.0 and no warnings. The generated HTML contains the archive link and both commands.python -m pip install .installs 4.3.0+dev, andpython -m pip install hpackinstalls 4.2.0. Both installed packages pass an encode/decode check.Merge danger
Door: two-way. Blast radius: documentation.
Only
docs/source/installation.rstchanges.Unverified
Installation on Windows and macOS, visual inspection of the rendered page, hosted CI and scanner parser coverage. The unit-test matrix was not rerun for this documentation change; the unchanged base previously passed 502 tests with 100% branch coverage on Linux and Windows Python 3.14.