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 <https://sphinx-contributors.readthedocs.io/en/latest/contribute.html>`_ for details on our code of conduct and development process.
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>`_.
Raw data
{
"_id": null,
"home_page": "https://github.com/dgarcia360/sphinx-contributors",
"name": "sphinx_contributors",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "David Garcia",
"author_email": "hi@davidgarcia.dev",
"download_url": "https://files.pythonhosted.org/packages/21/9d/7505ca9f128ab5a0b38fc51e57d428a54f28767596e99c05a26155ea603a/sphinx_contributors-0.2.7.tar.gz",
"platform": null,
"description": "sphinx-contributors\n===================\n\n``sphinx-contributors`` is a Sphinx extension that helps you recognize the people who have contributed to an open-source project.\n\n.. image:: https://raw.githubusercontent.com/dgarcia360/sphinx-contributors/master/docs/source/_static/example_avatars.png\n\nFeatures\n---------\n\n**Celebrate contributions**\n\nShow the list of users who have contributed to a repository in your docs.\n\n**Configurable**\n\nChoose how many contributors show and sort them by the number of commits.\n\nSupported platforms\n---------------------\n\n``sphinx-contributors`` only works with GitHub public repositories.\n\nInstallation\n------------\n\n#. Install ``sphinx-contributors`` using PIP.\n\n .. code-block:: bash\n\n pip install sphinx-contributors\n\n\n#. Add the extension to your Sphinx project ``conf.py`` file.\n\n .. code-block:: python\n\n extensions = ['sphinx_contributors']\n\nUsage\n-----\n\nUsing the directive:\n\n.. code-block:: rst\n\n .. contributors:: sphinx-doc/sphinx\n\nRenders:\n\n.. image:: https://raw.githubusercontent.com/dgarcia360/sphinx-contributors/master/docs/source/_static/example.png\n\nCheck out the full documentation for more customizable options at https://sphinx-contributors.readthedocs.io/\n\nContributing\n------------\n\nWe encourage public contributions!\nPlease review `CONTRIBUTING <https://sphinx-contributors.readthedocs.io/en/latest/contribute.html>`_ for details on our code of conduct and development process.\n\nLicense\n-------\n\nCopyright (c) 2018 - present David Garcia (`@dgarcia360 <https://twitter.com/dgarcia360>`_).\n\nLicensed under the `MIT License <https://github.com/dgarcia360/sphinx-contributors/blob/main/LICENSE.md>`_.\n",
"bugtrack_url": null,
"license": null,
"summary": "Contributors extension for Sphinx.",
"version": "0.2.7",
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "9a95573aeae3e67ab90a4600b3758fba9d06bad9e7d68d76959e8018762c2858",
"md5": "ac70ef293a84fa893760cd3185ef2c79",
"sha256": "f409295eb22f05606528ff3a9b93b4ae076d93d3153de13ff47bfcdd1c792463"
},
"downloads": -1,
"filename": "sphinx_contributors-0.2.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ac70ef293a84fa893760cd3185ef2c79",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 4669,
"upload_time": "2023-01-10T16:43:31",
"upload_time_iso_8601": "2023-01-10T16:43:31.775337Z",
"url": "https://files.pythonhosted.org/packages/9a/95/573aeae3e67ab90a4600b3758fba9d06bad9e7d68d76959e8018762c2858/sphinx_contributors-0.2.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "219d7505ca9f128ab5a0b38fc51e57d428a54f28767596e99c05a26155ea603a",
"md5": "7ff8fe3657645ce61639ade0d82b12fc",
"sha256": "aace731366096f2104a06eca77b9354b11768ddec149d699520c254f09cbb4f4"
},
"downloads": -1,
"filename": "sphinx_contributors-0.2.7.tar.gz",
"has_sig": false,
"md5_digest": "7ff8fe3657645ce61639ade0d82b12fc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 394864,
"upload_time": "2023-01-10T16:43:37",
"upload_time_iso_8601": "2023-01-10T16:43:37.530244Z",
"url": "https://files.pythonhosted.org/packages/21/9d/7505ca9f128ab5a0b38fc51e57d428a54f28767596e99c05a26155ea603a/sphinx_contributors-0.2.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-10 16:43:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "dgarcia360",
"github_project": "sphinx-contributors",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sphinx_contributors"
}
JSON
