Skip to content

Commit 26339e3

Browse files
committed
Add synopsis to modules
1 parent 532da81 commit 26339e3

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/reST/ext/documenters.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,12 @@ def format_signature(self, **kwargs):
6868
def get_doc(self, encoding=None, ignore=1):
6969
return [get_doc(self.env, self.object).splitlines()]
7070

71+
def add_directive_header(self, sig: str) -> None:
72+
super().add_directive_header(sig)
73+
if "module" in self.objtype:
74+
sourcename = self.get_sourcename()
75+
self.add_line(f" :synopsis: {self.get_doc()[0][0]}", sourcename)
76+
7177
def get_object_members(self, want_all):
7278
members_check_module, members = super().get_object_members(want_all)
7379
members = (

0 commit comments

Comments
 (0)