File: reference.rst

package info (click to toggle)
python-sphinx-contributors 0.2.7-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 608 kB
  • sloc: python: 239; makefile: 20
file content (35 lines) | stat: -rw-r--r-- 1,001 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
Reference
=========

Contributors directive
----------------------

.. rst:directive:: .. contributors:: username/repository

    .. rst:directive:option:: limit
      :type: integer

      Number of contributors to list, between 1 and 100. The default value is 10.

      .. versionadded:: 0.2.2

    .. rst:directive:option:: order
      :type: string

      Results are sorted by the number of contributions. This parameter controls whether they are sorted by most active users first (``DESC``) or least active users first (``ASC``). Default is ``DESC``.

      .. versionadded:: 0.2.2

    .. rst:directive:option:: avatars
      :type: boolean

      Whether to include an image with the avatar returned by GitHub. Use CSS to customize the image size, since the returned images might vary.

      .. versionadded:: 0.2.3

    .. rst:directive:option:: contributions
      :type: boolean

      Whether to show the total number of contributions by each user or not.

      .. versionadded:: 0.2.3