Skip to content

Commit

Permalink
Update README (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
Daltz333 authored Aug 24, 2020
1 parent b9ea794 commit 6796d93
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# sphinxext-rediraffe
![ci](https://github.com/wpilibsuite/sphinxext-rediraffe/workflows/ci/badge.svg)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

Sphinx Extension to redirect files
Expand All @@ -10,11 +11,11 @@ Additionally, a builder is provided to check that deleted/renamed files in your

Rediraffe supports the html and dirhtml builders.

Note: Chained redirects will be resolved. For example, if a config has 6 chained redirects, all 6 links will redirect directly to the final link. The enduser will never experience more than 1 redirection.
Note: Chained redirects will be resolved. For example, if a config has 6 chained redirects, all 6 links will redirect directly to the final link. The end user will never experience more than 1 redirection.

## Installation

`python -m pip install git+https://github.com/wpilibsuite/sphinxext-rediraffe.git`
`python -m pip install sphinxext-rediraffe`


## Usage
Expand Down

0 comments on commit 6796d93

Please sign in to comment.