Skip to content

Commit 7eec191

Browse files
committed
Docstring written for setup() function
1 parent 288d38e commit 7eec191

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

doc/sphinxext/contributors.py

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,25 @@ def run(self):
6565

6666

6767
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+
"""
6887
app.add_directive("contributors", ContributorsDirective)
6988

7089
return {"version": "0.1", "parallel_read_safe": True, "parallel_write_safe": True}

0 commit comments

Comments
 (0)