No project description provided
Project description
sphinx-all-contributors
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:
- Contributor Name 1 - ideas, docs
- Contributor Name 2 - code
Features
- Automatically reads the list of contributors from a
.all-contributorsrc
file. - Customizable relative path to the
.all-contributorsrc
file. - Outputs a list of contributors in a clean, human-readable format.
Installation
- Clone or download this repository.
- Install the package by running:
pip install .
Usage
Add sphinx-all-contributors
to the extensions
list in your conf.py
:
# conf.py
extensions = [
"sphinx_all_contributors",
# other extensions
]
Create a .all-contributorsrc
file in your documentation source directory (or another location). You can create this file manually following the all-contributors format, or you can use the all-contributors bot to automate this process and ensure that your contributor data is accurate and up-to-date. An example .all-contributorsrc
file looks like this:
{
"contributors": [
{
"name": "Contributor Name 1",
"contributions": ["ideas", "docs"]
},
{
"name": "Contributor Name 2",
"contributions": ["code"]
}
]
}
In 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).
Example 1: Using the default .all-contributorsrc
path:
.. all-contributors::
Example 2: Specifying a relative path to the .all-contributorsrc
file:
.. all-contributors:: config/.all-contributorsrc
Build your documentation:
make html
The generated HTML (or other formats) will contain a list of contributors in the format:
- Contributor Name 1 - ideas, docs
- Contributor Name 2 - code
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinx-all-contributors-0.1.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b6dca8a8959b2b3be68551796519042fcfbdaf313aff5b13703a7be0e23c8a68 |
|
MD5 | a8b97010341b09e4a5958d55d26ab3da |
|
BLAKE2b-256 | 8150b155aded6e3d08eec4c73ffdf20c240358064144247d350d4d9a99bf69c0 |
Hashes for sphinx_all_contributors-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 535f4229256ed59f3e0c8090b0ceea6ad5279d14b76cff7022c651fb3cebf4e5 |
|
MD5 | 3693247e22abbb8d30c772e52e60a953 |
|
BLAKE2b-256 | 794b406c2feab0544d9ec596b554e821a725b49f1f16691e95c4a9ca044193df |