Overview
========

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

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.

Get started
-----------

.. toctree::
   :maxdepth: 2

   installation
   usage
   customization
   who-is-using-it
   reference
   contribute

Contributing
------------

We encourage public contributions!
Please review `CONTRIBUTING <https://sphinx-contributors.readthedocs.io/en/latest/contribute.html>`_ for details on our code of conduct and development process.

**THANK YOU TO THE CONTRIBUTORS OF SPHINX-CONTRIBUTORS!**

.. contributors:: dgarcia360/sphinx-contributors
   :avatars:
   :exclude: dependabot[bot]

License
-------

Copyright (c) 2018 - present David Garcia (`@dgarcia360 <https://twitter.com/dgarcia360>`_).

Licensed under the `MIT License <https://github.com/dgarcia360/sphinx-contributors/blob/main/LICENSE.md>`_.
