Framework
- Sphinx :: Extension
Programming Language
- Python :: 3
- Python :: 3.10
- Python :: 3.11
- Python :: 3.12
- Python :: 3.13
- Python :: 3.14
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.
