Skip to main content

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 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

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

sphinxext-toptranslators-0.1.3.tar.gz (3.8 kB view hashes)

Uploaded Source

Built Distribution

sphinxext_toptranslators-0.1.3-py3-none-any.whl (5.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page