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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
|
"""Sphinx extension for listing code contributors to a release.
Usage::
.. contributors:: v0.23.0..v0.23.1
This will be replaced with a message indicating the number of
code contributors and commits, and then list each contributor
individually. For development versions (before a tag is available)
use::
.. contributors:: v0.23.0..v0.23.1|HEAD
While the v0.23.1 tag does not exist, that will use the HEAD of the
branch as the end of the revision range.
"""
from docutils import nodes
from docutils.parsers.rst import Directive
class ContributorsDirective(Directive):
required_arguments = 1
name = "contributors"
def run(self):
return [nodes.paragraph(), nodes.Text("For contributors, please see /usr/share/doc/contributors_list.txt or https://github.com/pandas-dev/pandas/graphs/contributors")]
range_ = self.arguments[0]
if range_.endswith("x..HEAD"):
return [nodes.paragraph(), nodes.bullet_list()]
try:
components = build_components(range_)
except git.GitCommandError as exc:
return [
self.state.document.reporter.warning(
f"Cannot find contributors for range {repr(range_)}: {exc}",
line=self.lineno,
)
]
else:
message = nodes.paragraph()
message += nodes.Text(components["author_message"])
listnode = nodes.bullet_list()
for author in components["authors"]:
para = nodes.paragraph()
para += nodes.Text(author)
listnode += nodes.list_item("", para)
return [message, listnode]
def setup(app):
app.add_directive("contributors", ContributorsDirective)
return {"version": "0.1", "parallel_read_safe": True, "parallel_write_safe": True}
|
