We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 288d38e commit 7eec191Copy full SHA for 7eec191
doc/sphinxext/contributors.py
@@ -65,6 +65,25 @@ def run(self):
65
66
67
def setup(app):
68
+ """
69
+ Setup function for the Sphinx extension.
70
+
71
+ This function registers the `contributors` directive with the Sphinx application.
72
73
+ Parameters
74
+ ----------
75
+ app : sphinx.application.Sphinx
76
+ The Sphinx application object.
77
78
+ Returns
79
+ -------
80
+ dict
81
+ A dictionary containing metadata about the extension.
82
83
+ Notes
84
+ -----
85
+ - This function is typically called by Sphinx during the initialization phase.
86
87
app.add_directive("contributors", ContributorsDirective)
88
89
return {"version": "0.1", "parallel_read_safe": True, "parallel_write_safe": True}
0 commit comments