Metadata-Version: 2.1
Name: sphinxext-toptranslators
Version: 0.1.2
Summary: Sphinx Extension to grab top contributors
Home-page: https://github.com/wpilibsuite/sphinxext-toptranslators
Author: Dalton Smith
Author-email: daltzsmith@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Plugins
Classifier: Environment :: Web Environment
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Text Processing
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: sphinx (>=2.0)
Requires-Dist: gitpython

# 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 to `numerical`

- *: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
```


