Sphinx Extension to grab top contributors
Project description
sphinxext-toptranslators
Sphinx extension to grab top contributors from a PO directory that Sphinx generates.
Installation
pip install sphinxext-toptranslators
Usage
Directive Configuration
Directive is .. toptranslators:: GITHUB_REPO_NAME
with the following options:
-
:locale: name of the locale, examples are (fr, es). Please note that this flag is mandatory
-
:limit: limit the number of shown contributors
-
:order: default is
alphabetical
, but can be set tonumerical
-
:hide_contributions: Whether or not to hide how many contributions each contributor as made. default is
false
Example
.. toptranslators:: wpilibsuite/frc-docs-translations
:locale: fr
:limit: 10
:order: alphabetical
:hide_contributions: true
Project details
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
File details
Details for the file sphinxext-toptranslators-0.1.2.tar.gz
.
File metadata
- Download URL: sphinxext-toptranslators-0.1.2.tar.gz
- Upload date:
- Size: 3.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 122ddd31e7dd0d2969b2ebfb128015edea24461c0b2de09184af16f5231ee960 |
|
MD5 | 52c91b89bb0786dcbc98fc4e7e777c98 |
|
BLAKE2b-256 | 79bf5197e773faea3e6f6edee3ea751f5852894f0811390b1e854824348343a2 |
File details
Details for the file sphinxext_toptranslators-0.1.2-py3-none-any.whl
.
File metadata
- Download URL: sphinxext_toptranslators-0.1.2-py3-none-any.whl
- Upload date:
- Size: 4.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1438cfbd5f023e69b4e02f16384a1b12ac7dfbd5447deb73cb07b6cd72ee0b48 |
|
MD5 | 89e4178306023d565d238f855113e272 |
|
BLAKE2b-256 | 3f78e828c2c2ebb751b0bf54af4d533103aa63ed2b18eb964c56f86c15c9f58e |