sphinx-contributors
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.
Installation
Install
sphinx-contributorsusing PIP.pip install sphinx-contributors
Add the extension to your Sphinx project
conf.pyfile.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.