sphinx_contributors 0.2.4

Contributors extension for Sphinx.

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

Features

Promote contributions

The extension retrieves from GitHub the list of users who have contributed to a repository.

Configurable

The extension lets you define the number of contributors to show and sort them by the number of commits.

Supported platforms

sphinx-contributors only works with GitHub public repositories.

Installation

1. Install sphinx-contributors using PIP.

   pip install sphinx-contributors

2. Add the extension to your Sphinx project conf.py file.

   extensions = ['sphinx_contributors']

Usage

Using the directive:

..  contributors:: sphinx-doc/sphinx

Renders:

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.