Overview

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+.

Get started

Contributing

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

THANK YOU TO THE CONTRIBUTORS OF SPHINX-CONTRIBUTORS!

License

Copyright (c) 2018 - present David Garcia (@dgarcia360).

Licensed under the MIT License.