[2492] Add new page to document installation methods #3941
Conversation
|
|
||
| ## Install from PyPI | ||
|
|
||
| To install the latest release of _Black_ from [PyPI] (Requires Python 3.8+), use: |
There was a problem hiding this comment.
I wonder if we can link to the pyproject.toml directive here to avoid having yet another place to upgrade when we move to requiring >= 3.9 - All for ideas here but can live with it if it's to hard ...
There was a problem hiding this comment.
I'm checking if this can be done via tomli and Sphinx configuration somehow.
| performance, compiled using [mypyc] | ||
|
|
||
| By default, `pip` will prefer a compatible wheel and revert to the source distribution | ||
| if no such wheels are found, as outlined in [Python documentation]. |
There was a problem hiding this comment.
| if no such wheels are found, as outlined in [Python documentation]. | |
| if no such wheels are found, as outlined in [Python documentation](LINK). |
Did you forget the link?
There was a problem hiding this comment.
The links were all declared at the end of the page, similar to other pages in the documentation. I've changed all of them to avoid confusion.
| To install the latest version of _Black_ from GitHub, use: | ||
|
|
||
| `pip install git+https://github.com/psf/black` |
There was a problem hiding this comment.
| To install the latest version of _Black_ from GitHub, use: | |
| `pip install git+https://github.com/psf/black` | |
| To install the latest version of _Black_ from GitHub, use: | |
| `pip install git+https://github.com/psf/black` | |
| - This will install from the latest commit from `main` branch |
| Official _Black_ Docker images are available on [Docker Hub]. For more information, | ||
| check the [Black Docker image] section. |
There was a problem hiding this comment.
| Official _Black_ Docker images are available on [Docker Hub]. For more information, | |
| check the [Black Docker image] section. | |
| Official _Black_ Docker images are available on [Docker Hub](https://hub.docker.com/r/pyfound/black). For more information, | |
| check the [Black Docker image](LINK_TO_PAGE) page. | |
| - `docker run --rm --volume $(pwd):/src --workdir /src pyfound/black:latest_release black --check .` |
Command example optional but I think we should fix the link to make this page more useful.
There was a problem hiding this comment.
I left out the command example because it's already present in the Black Docker page, can add it if required.
|
|
||
| To install the latest release of _Black_ from [PyPI] (Requires Python 3.8+), use: | ||
|
|
||
| `pip install black` |
There was a problem hiding this comment.
O - Just thought of it - Please talk about all black's optional installs in this section too, please.
Description
Based on the comments in #2492 , I've made the following documentation additions:
Checklist - did you ...
CHANGES.mdif necessary?