https://github.com/dgarcia360/sphinx-contributors
Sphinx extension to show some ❤️ to your GitHub contributors
https://github.com/dgarcia360/sphinx-contributors
documentation github sphinx sphinx-doc sphinx-extension
Last synced: 10 months ago
JSON representation
Sphinx extension to show some ❤️ to your GitHub contributors
- Host: GitHub
- URL: https://github.com/dgarcia360/sphinx-contributors
- Owner: dgarcia360
- License: mit
- Created: 2018-06-17T12:46:32.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-03-08T15:50:12.000Z (about 2 years ago)
- Last Synced: 2024-12-12T16:07:21.229Z (over 1 year ago)
- Topics: documentation, github, sphinx, sphinx-doc, sphinx-extension
- Language: Python
- Homepage: https://sphinx-contributors.readthedocs.io
- Size: 435 KB
- Stars: 9
- Watchers: 3
- Forks: 4
- Open Issues: 8
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- License: LICENSE.md
Awesome Lists containing this project
README
sphinx-contributors
===================
``sphinx-contributors`` is a Sphinx extension that helps you recognize the people who have contributed to an open-source project.
.. image:: https://raw.githubusercontent.com/dgarcia360/sphinx-contributors/master/docs/source/_static/example_avatars.png
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-contributors`` using PIP.
.. code-block:: bash
pip install sphinx-contributors
#. Add the extension to your Sphinx project ``conf.py`` file.
.. code-block:: python
extensions = ['sphinx_contributors']
Usage
-----
Using the directive:
.. code-block:: rst
.. contributors:: sphinx-doc/sphinx
Renders:
.. image:: https://raw.githubusercontent.com/dgarcia360/sphinx-contributors/master/docs/source/_static/example.png
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 `_.