Skip to content

Commit

Permalink
Merge pull request #181 from ewels/tweak-docs-install-box
Browse files Browse the repository at this point in the history
Tweak docs install box
  • Loading branch information
dwreeves authored Apr 15, 2024
2 parents 9d59ac9 + ead2f36 commit 59c390b
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 10 deletions.
23 changes: 13 additions & 10 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,50 +57,53 @@ Click, formatted with Rich, with minimal customisation required.
## Installation

=== "pip"
```{.shell, .copy}
```shell
pip install rich-click
```

=== "uv"
```{.shell, .copy}
```shell
uv pip install rich-click
```

=== "Rye"
```{.shell, .copy}
```shell
rye add rich-click
rye sync
```

=== "Poetry"
```{.shell, .copy}
```shell
poetry add rich-click
```

=== "Pipenv"
```{.shell, .copy}
```shell
pipenv install rich-click
```

=== "conda"
[**rich-click**](https://anaconda.org/conda-forge/rich-click) is available via the conda-forge channel (see [docs](https://conda-forge.org/docs/user/introduction.html#how-can-i-install-packages-from-conda-forge)).
```{.shell, .copy}
```shell
conda install rich-click
```
!!! note
[**rich-click** is available](https://anaconda.org/conda-forge/rich-click) via the conda-forge channel (see [docs](https://conda-forge.org/docs/user/introduction.html#how-can-i-install-packages-from-conda-forge)).

=== "MacPorts"
This installation method is deprecated.
```{.shell, .copy}
```shell
sudo port install py-rich-click
```

!!! danger "Depreciated"
This installation method is deprecated.

## Examples

### Simple example

To use rich-click in your code, replace `import click` with `import rich_click as click` in your existing click CLI:

```{ .python .copy }
```python
import rich_click as click

@click.command()
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ theme:
repo: fontawesome/brands/github
features:
- content.tabs.link
- content.code.copy
- navigation.tabs
- navigation.expand
# - navigation.indexes
Expand Down

0 comments on commit 59c390b

Please sign in to comment.