Add synopsis to modules

Matiiss · Nov 13, 2024 · 26339e3 · 26339e3
1 parent 532da81
commit 26339e3
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/docs/reST/ext/documenters.py b/docs/reST/ext/documenters.py
@@ -68,6 +68,12 @@ def format_signature(self, **kwargs):
     def get_doc(self, encoding=None, ignore=1):
         return [get_doc(self.env, self.object).splitlines()]
 
+    def add_directive_header(self, sig: str) -> None:
+        super().add_directive_header(sig)
+        if "module" in self.objtype:
+            sourcename = self.get_sourcename()
+            self.add_line(f"   :synopsis: {self.get_doc()[0][0]}", sourcename)
+
     def get_object_members(self, want_all):
         members_check_module, members = super().get_object_members(want_all)
         members = (