Clean up CDP module pages #10

Each module page now has separate sections for types, commands, and
events.

Author: mehaase

generator/generate.py

@@ -28,10 +28,8 @@
 '''.format(SHARED_HEADER)
 
 MODULE_HEADER = '''{}
-
-\'\'\'
-CDP {{}} Domain{{}}
-\'\'\'
+#
+# CDP domain: {{}}{{}}
 
 from __future__ import annotations
 from cdp.util import event_class, T_JSON_DICT
@@ -843,12 +841,24 @@ def generate_sphinx(self) -> str:
         '''
         docs = self.domain + '\n'
         docs += '=' * len(self.domain) + '\n\n'
-
         if self.description:
             docs += f'{self.description}\n\n'
+        if self.experimental:
+            docs += '*This CDP domain is experimental.*\n\n'
+        docs += f'.. module:: cdp.{self.module}\n\n'
+        docs += '* Types_\n* Commands_\n* Events_\n\n'
 
-        docs += f'.. automodule:: cdp.{self.module}\n'
-        docs += '  :members:\n'
+        docs += 'Types\n-----\n'
+        for type in self.types:
+            docs += f'\n.. autoclass:: {type.id}\n'
+
+        docs += '\nCommands\n--------\n'
+        for command in sorted(self.commands, key=operator.attrgetter('py_name')):
+            docs += f'\n.. autofunction:: {command.py_name}\n'
+
+        docs += '\nEvents\n------\n'
+        for event in self.events:
+            docs += f'\n.. autoclass:: {event.py_name}\n'
 
         return docs
 

generator/test_generate.py

@@ -911,8 +911,28 @@ def test_cdp_domain_sphinx():
 
         This is the animation domain.
 
-        .. automodule:: cdp.animation
-          :members:
+        *This CDP domain is experimental.*
+
+        .. module:: cdp.animation
+
+        * Types_
+        * Commands_
+        * Events_
+
+        Types
+        -----
+
+        .. autoclass:: KeyframeStyle
+
+        Commands
+        --------
+
+        .. autofunction:: get_current_time
+
+        Events
+        ------
+
+        .. autoclass:: AnimationCanceled
     """)
     domain = CdpDomain.from_json(json_domain)
     actual = domain.generate_sphinx()