sphinx-contributors is a Sphinx extension that automatically lists the people who have contributed to your GitHub repositories, right inside your documentation.
Features
List contributors from one or multiple GitHub repositories in a single directive.
Display real names, avatars, and contribution counts.
Manually include contributors not detected by the API (e.g., Co-authored-by contributors).
Exclude bots and specific users.
Sort by most or least active, and limit the number shown.
Requirements
GitHub public repositories.
Python 3.10+ and Sphinx 7.0+.
Installation
Install sphinx-contributors using PIP.
pip install sphinx-contributorsAdd the extension to your Sphinx project conf.py file.
extensions = ['sphinx_contributors']
Usage
Using the directive:
.. contributors:: sphinx-doc/sphinxRenders:
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
Copyright (c) 2018 - present David Garcia (@dgarcia360).
Licensed under the MIT License.
1 maintainer
Metadata
1 maintainer
Release files for sphinx_contributors 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_contributors-0.3.0.tar.gz | 399.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_contributors-0.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 405.1 kB
Release files / sphinx_contributors-0.3.0.tar.gz
| Download URL | sphinx_contributors-0.3.0.tar.gz |
|---|---|
| Size | 399.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9b8c94fb5c1f851719a3abb9e15281c34f511b8aba71c97ac9c30bcb14f907fd
|
|
BLAKE2b-256 checksum How to use checksums |
b56853a8170828c2e175e5333560d413c7721c323ba9ffbbc86c3c8346f6eb4b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.32.5
|
Release files / sphinx_contributors-0.3.0-py3-none-any.whl
| Download URL | sphinx_contributors-0.3.0-py3-none-any.whl |
|---|---|
| Size | 5.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fd762cf65d4b931f4e073c1a0ae37aa5881b8a01788fb633963ba6b104c1e90b
|
|
BLAKE2b-256 checksum How to use checksums |
efbdb6c802bf3fa12cf60dc1685412a934c562426e3cc414d4d8c1c536ddad8a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-requests/2.32.5
|
