sphinx_contributors

Contributors extension for Sphinx.

Project description

sphinx-contributors is a Sphinx extension that helps you recognize the people who have contributed to an open-source project.

https://raw.githubusercontent.com/dgarcia360/sphinx-contributors/master/docs/source/_static/example_avatars.png

Features

Celebrate contributions

Show the list of users who have contributed to a repository in your docs.

Configurable

Choose how many contributors show and sort them by the number of commits.

Supported platforms

sphinx-contributors only works with GitHub public repositories.

Installation

Install sphinx-contributors using PIP.
```
pip install sphinx-contributors
```
Add the extension to your Sphinx project conf.py file.
```
extensions = ['sphinx_contributors']
```

Usage

Using the directive:

..  contributors:: sphinx-doc/sphinx

Renders:

https://raw.githubusercontent.com/dgarcia360/sphinx-contributors/master/docs/source/_static/example.png

Check out the full documentation for more customizable options at https://sphinx-contributors.readthedocs.io/

Contributing

We encourage public contributions! Please review CONTRIBUTING for details on our code of conduct and development process.

License

Licensed under the MIT License.

Project details

Release history Release notifications | RSS feed

This version

0.2.7

Jan 10, 2023

0.2.6

Jan 26, 2022

0.2.5

Jan 25, 2022

0.2.4

Jan 21, 2022

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_contributors-0.2.7.tar.gz (394.9 kB view details)

Uploaded Jan 10, 2023 Source

Built Distribution

sphinx_contributors-0.2.7-py3-none-any.whl (4.7 kB view details)

Uploaded Jan 10, 2023 Python 3

File details

Details for the file sphinx_contributors-0.2.7.tar.gz.

File metadata

Download URL: sphinx_contributors-0.2.7.tar.gz
Upload date: Jan 10, 2023
Size: 394.9 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: python-requests/2.27.1

File hashes

Hashes for sphinx_contributors-0.2.7.tar.gz
Algorithm	Hash digest
SHA256	`aace731366096f2104a06eca77b9354b11768ddec149d699520c254f09cbb4f4`
MD5	`7ff8fe3657645ce61639ade0d82b12fc`
BLAKE2b-256	`219d7505ca9f128ab5a0b38fc51e57d428a54f28767596e99c05a26155ea603a`

See more details on using hashes here.

File details

Details for the file sphinx_contributors-0.2.7-py3-none-any.whl.

File metadata

Download URL: sphinx_contributors-0.2.7-py3-none-any.whl
Upload date: Jan 10, 2023
Size: 4.7 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: python-requests/2.27.1

File hashes

Hashes for sphinx_contributors-0.2.7-py3-none-any.whl
Algorithm	Hash digest
SHA256	`f409295eb22f05606528ff3a9b93b4ae076d93d3153de13ff47bfcdd1c792463`
MD5	`ac70ef293a84fa893760cd3185ef2c79`
BLAKE2b-256	`9a95573aeae3e67ab90a4600b3758fba9d06bad9e7d68d76959e8018762c2858`