#12145 Update the install documentation.#12147
Merged
Conversation
Member
Author
|
needs-review |
Member
|
Merging trunk to see if the macOS failure will bother us less |
glyph
approved these changes
May 3, 2024
Member
glyph
left a comment
There was a problem hiding this comment.
Looks like a nice consolidation.
Member
And it did, hooray. Looks like the build really is more reliable now. An actual bug fixed! |
Co-authored-by: Glyph <glyph@twistedmatrix.com>
Member
Author
|
Thanks for the review. I have enabled the auto-merge on this. Great work for the macOS fix. It was a huge pain . |
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
3 participants
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.
Scope and purpose
Fixes #12145
This updated the documentation about installing Twisted.
We had multiple pages in which the install was documented.
All install related info was moved into a single page.
Redirection were created for the existing page... so we will not have broken links.
THe install process is quite simple and standard, so I think that a single page is good enough.
Also, rather that duplicate the info from pyproject.toml, the documentation only instruct you to check the pyproject.toml file for the actual list of deps.
How to check
New install doc page
https://twisted--12147.org.readthedocs.build/en/12147/installation.html
Redirecting from previous pages
https://twisted--12147.org.readthedocs.build/en/12147/installation/index.html
https://twisted--12147.org.readthedocs.build/en/12147/installation/howto/optional.html
Link to the documenatation:
The install source code docs now has a link to the new doc page https://github.com/twisted/twisted/blob/12145-optional-install-docs/INSTALL.rst
The README source code also has a link to the new page https://github.com/twisted/twisted/blob/12145-optional-install-docs/README.rst
These linked page is not yet ready.
It will be available once this PR is merged in trunk.