{"id":18152083,"url":"https://github.com/tkoyama010/sphinx-all-contributors","last_synced_at":"2025-08-17T16:36:35.722Z","repository":{"id":255722978,"uuid":"852024463","full_name":"tkoyama010/sphinx-all-contributors","owner":"tkoyama010","description":"all-contributors for Sphinx users","archived":false,"fork":false,"pushed_at":"2025-02-10T23:55:50.000Z","size":91,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-11T00:30:24.129Z","etag":null,"topics":["acknowledgements","all-contributors","contributors","docs","documentation","documentation-tool","open-source","open-source-mane","open-source-tooling","python","recognition","restructuredtext","sphinx","sphinx-doc","sphinx-docs","sphinx-documentation","sphinx-extension"],"latest_commit_sha":null,"homepage":"https://sphinx-all-contributors.readthedocs.io/en/stable/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tkoyama010.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"tkoyama010"}},"created_at":"2024-09-04T05:06:19.000Z","updated_at":"2025-02-10T23:55:52.000Z","dependencies_parsed_at":"2024-11-11T22:20:13.770Z","dependency_job_id":"4978a7ef-6ac7-451f-8e48-eb8ed4676a8e","html_url":"https://github.com/tkoyama010/sphinx-all-contributors","commit_stats":null,"previous_names":["tkoyama010/sphinx-all-contributors"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tkoyama010%2Fsphinx-all-contributors","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tkoyama010%2Fsphinx-all-contributors/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tkoyama010%2Fsphinx-all-contributors/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tkoyama010%2Fsphinx-all-contributors/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tkoyama010","download_url":"https://codeload.github.com/tkoyama010/sphinx-all-contributors/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238603651,"owners_count":19499490,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["acknowledgements","all-contributors","contributors","docs","documentation","documentation-tool","open-source","open-source-mane","open-source-tooling","python","recognition","restructuredtext","sphinx","sphinx-doc","sphinx-docs","sphinx-documentation","sphinx-extension"],"created_at":"2024-11-02T02:05:35.541Z","updated_at":"2025-08-17T16:36:35.705Z","avatar_url":"https://github.com/tkoyama010.png","language":"Python","funding_links":["https://github.com/sponsors/tkoyama010"],"categories":[],"sub_categories":[],"readme":"# sphinx-all-contributors\n\n![All Contributors](https://img.shields.io/github/all-contributors/tkoyama010/sphinx-all-contributors?color=ee8449)\n[![Documentation Status](https://readthedocs.org/projects/sphinx-all-contributors/badge/?version=latest)](https://sphinx-all-contributors.readthedocs.io/en/latest/?badge=latest)\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)\n[![code style:prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)\n\n`sphinx-all-contributors` is a Sphinx extension that allows you to easily display a list of contributors from a `.all-contributorsrc` file in your Sphinx documentation. The list is generated in a simple, readable format like:\n\n```\n- Contributor Name 1 for ideas, docs\n- Contributor Name 2 for code\n```\n\n## Features\n\n- Automatically reads the list of contributors from a `.all-contributorsrc` file.\n- Customizable relative path to the `.all-contributorsrc` file.\n- Outputs a list of contributors in a clean, human-readable format.\n\n## Installation\n\n[![pypi](https://img.shields.io/pypi/v/sphinx-all-contributors?label=pypi\u0026logo=python\u0026logoColor=white)](https://pypi.org/project/sphinx-all-contributors/)\n\n```shell\npip install sphinx-all-contributors\n```\n\n## Usage\n\nAdd `sphinx-all-contributors` to the `extensions` list in your `conf.py`:\n\n```python\n# conf.py\nextensions = [\n    \"sphinx_all_contributors\",\n    # other extensions\n]\n```\n\nCreate a `.all-contributorsrc` file in your documentation source directory (or another location). You can create this file manually following the [all-contributors](https://allcontributors.org/docs/en/bot/configuration) format, or you can use the [all-contributors bot](https://allcontributors.org/docs/en/bot/overview) to automate this process and ensure that your contributor data is accurate and up-to-date. An example `.all-contributorsrc` file looks like this:\n\n```json\n{\n  \"contributors\": [\n    {\n      \"name\": \"Contributor Name 1\",\n      \"contributions\": [\"ideas\", \"docs\"]\n    },\n    {\n      \"name\": \"Contributor Name 2\",\n      \"contributions\": [\"code\"]\n    }\n  ]\n}\n```\n\nIn your `.rst` file, use the `all-contributors` directive to display the list of contributors. You can specify the relative path to the `.all-contributorsrc` file or omit it to use the default path (`.all-contributorsrc` in the source directory).\n\nExample 1: Using the default `.all-contributorsrc` path:\n\n```rst\n.. all-contributors::\n```\n\nExample 2: Specifying a relative path to the `.all-contributorsrc` file:\n\n```rst\n.. all-contributors:: config/.all-contributorsrc\n```\n\nBuild your documentation:\n\n```bash\nmake html\n```\n\nThe generated HTML (or other formats) will contain a list of contributors in the format:\n\n```\n- Contributor Name 1 for ideas, docs\n- Contributor Name 2 for code\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftkoyama010%2Fsphinx-all-contributors","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftkoyama010%2Fsphinx-all-contributors","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftkoyama010%2Fsphinx-all-contributors/lists"}