sphinx_contributors

Contributors extension for Sphinx.

Project description

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

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.

sphinx-contributors only works with GitHub public repositories.

Install sphinx-contributors using PIP.
```
pip install sphinx-contributors
```
Add the extension to your Sphinx project conf.py file.
```
extensions = ['sphinx_contributors']
```

Using the directive:

..  contributors:: sphinx-doc/sphinx

Renders:

Check out the full documentation for more customizable options at https://sphinx-contributors.readthedocs.io/

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

Licensed under the MIT License.

This version

0.2.7

Jan 10, 2023

0.2.6

Jan 26, 2022

0.2.5

Jan 25, 2022

0.2.4

Jan 21, 2022

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Uploaded Jan 10, 2023 Source

Uploaded Jan 10, 2023 Python 3