Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md to add installation from PyPI #17

Merged
merged 2 commits into from
Sep 6, 2024
Merged

Update README.md to add installation from PyPI #17

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc23a55
Update README.md to add installation from PyPI
tkoyama010 Sep 6, 2024
b1bf175
Update README.md
tkoyama010 Sep 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
`sphinx-all-contributors` is a Sphinx extension that allows you to easily display a list of contributors from a `.all-contributorsrc` file in your Sphinx documentation. The list is generated in a simple, readable format like:

```
- Contributor Name 1 - ideas, docs
- Contributor Name 2 - code
- Contributor Name 1 for ideas, docs
- Contributor Name 2 for code
```

## Features
Expand All @@ -18,11 +18,10 @@

## Installation

1. Clone or download this repository.
1. Install the package by running:
[![pypi](https://img.shields.io/pypi/v/sphinx-all-contributors?label=pypi&logo=python&logoColor=white)](https://pypi.org/project/sphinx-all-contributors/)

```bash
pip install .
```shell
pip install sphinx-all-contributors
```

## Usage
Expand Down