install docs: reorganize, discourage installing pipx with pipx
#1109
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
- Added a note discouraging installing `pipx` with `pipx`, since that seems to be unsupported. E.g. `pipx remove pipx` breaks all programs installed with such a pipx, see the README of https://github.com/mattsb42-meta/pipx-in-pipx for more caveats. - I also added a link to the above project in the docs, mainly for its README. I'm not sure how well the project itself works; let me know if I should remove the link. - Reorganized the header structure of the installation docs slightly for clarity I checked with `nox -s watch-docs` that the resulting docs seem to look OK.
Previously, GitHub rendered the list correctly, but MkDocs didn't.
gaborbernat
approved these changes
Nov 30, 2023
|
Thanks for the review! |
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.
I also added a link to a seemingly relevant, but untested by me, project. Let me know if you'd prefer to remove that link.
docs/changelog.mdSummary of changes
Added a note discouraging installing
pipxwithpipx, since that seems tobe unsupported. E.g.
pipx remove pipxbreaks all programs installed withsuch a pipx, see the README of https://github.com/mattsb42-meta/pipx-in-pipx
for more caveats.
I also added a link to the above project in the docs, mainly for its README.
I'm not sure how well the project itself works; let me know if I should
remove the link.
Reorganized the header structure of the installation docs slightly for clarity
Fixed list spacing; MkDocs previously didn't render that list as a list.
Test plan
I checked with
nox -s watch-docsthat the resulting docs seem to look OK.