https://github.com/wpilibsuite/sphinxext-toptranslators

Grabs top translation contributors from PO files
https://github.com/wpilibsuite/sphinxext-toptranslators

sphinx-extension

Last synced: about 1 month ago
JSON representation

Grabs top translation contributors from PO files

• Host: GitHub
• URL: https://github.com/wpilibsuite/sphinxext-toptranslators
• Owner: wpilibsuite
• License: other
• Created: 2020-07-09T18:55:01.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2021-10-04T21:04:03.000Z (over 3 years ago)
• Last Synced: 2025-03-28T01:12:27.813Z (2 months ago)
• Topics: sphinx-extension
• Language: Python
• Homepage:
• Size: 36.1 KB
• Stars: 4
• Watchers: 6
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# 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

```