Skip to content

Commit

Permalink
docs: fix install
Browse files Browse the repository at this point in the history
  • Loading branch information
antazoey committed Sep 9, 2024
1 parent 409834d commit 60ab627
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,14 @@ The purpose of this plugin to share code for generating documentation across all

## Install

Install using `pip` or `uv` by either cloning this repo or accessing from pypi, e.g.:
Install the package from GitHub:

```sh
pip install sphinx-ape
pip install git+https://github.com/ApeWorX/sphinx-ape.git@main
```

**NOTE**: Also, you may clone and the package first and install locally.

Try `sphinx-ape --help` to check if it's installed.

## Quick Usage
Expand Down

0 comments on commit 60ab627

Please sign in to comment.