Merge branch 'refs/heads/forman-34-component_docs'

# Conflicts:
#	docs/components.md
#	mkdocs.yml

Author: forman

chartlets.py/chartlets/container.py

@@ -6,7 +6,15 @@
 
 @dataclass(frozen=True)
 class Container(Component, ABC):
+    """Base class for components that require child components to be useful."""
+
     children: list[Component] = field(default_factory=list)
+    """The child components."""
 
     def add(self, component: Component):
+        """Add a component.
+
+        Args:
+            component: the child component.
+        """
         self.children.append(component)

docs/components.md

@@ -1,12 +1,14 @@
-Given here is a list of the components supported by chartlets.
+Given here is a list of the components supported by Chartlets.
 
-Using the Python package, they can be imported from the `chartlets.components` 
-module, e.g.
+Using the Python package `chartlets`, the related component classes can be 
+imported from the `chartlets.components` module, e.g.
 
 ```python
 from chartlets.components import Checkbox
 ```
 
+## Classes
+
 ::: chartlets.components.Box
 
 ::: chartlets.components.Button
@@ -17,6 +19,8 @@ from chartlets.components import Checkbox
 
 ::: chartlets.components.Typography
 
+## Base classes
 
 ::: chartlets.Component
 
+::: chartlets.Container

mkdocs.yml

@@ -10,7 +10,13 @@ plugins:
             show_source: false
             show_if_no_docstring: false
             show_root_heading: true
-            heading_level: 2
+            heading_level: 3
+            toc: true
+            toc_depth: 1
+            members:
+             - methods
+             - classes
+             - attributes
 
 nav:
   - Home: index.md
@@ -21,6 +27,8 @@ nav:
 
 theme:
   name: material
+  features:
+    - toc.integrate  # Ensures TOC is integrated into the sidebar
   locale: en
   #include_sidebar: false
   palette: