👌 warn if grid/tab item not in parent

Author: chrisjsewell

README.md

@@ -48,6 +48,8 @@ grids items cannot contain headers; is this in anyway possible with docutils str
 
 naming of directives/roles: standard prefix?
 
+check grid-items and tab-items are inside parents (or auto-wrap?)
+
 handle latex
 
 card header/footer syntax?

sphinx_design/cards.py

@@ -38,7 +38,7 @@ class CardDirective(SphinxDirective):
     optional_arguments = 1  # card title
     final_argument_whitespace = True
     option_spec = {
-        # TODO adaptive width/ width based on content
+        # TODO adaptive width based on content
         "width": make_choice(["auto", "25", "50", "75", "100"]),
         "margin": margin_option,
         "text-align": text_align,

sphinx_design/grids.py

@@ -30,7 +30,6 @@ def setup_grids(app: Sphinx):
     app.add_directive(DIRECTIVE_NAME_GRID, GridDirective)
     app.add_directive(DIRECTIVE_NAME_GRID_ITEM, GridItemDirective)
     app.add_directive(DIRECTIVE_NAME_GRID_ITEM_CARD, GridItemCardDirective)
-    # TODO check all grid items have grid-row parents (or auto wrap in grid?)
 
 
 def _media_option(
@@ -169,6 +168,13 @@ class GridItemDirective(SphinxDirective):
     def run(self) -> List[nodes.Node]:
         """Run the directive."""
         self.assert_has_content()
+        if not is_component(self.state_machine.node, "grid-row"):
+            LOGGER.warning(
+                f"The parent of a 'grid-item' should be a 'grid-row' [{WARNING_TYPE}.grid]",
+                location=(self.env.docname, self.lineno),
+                type=WARNING_TYPE,
+                subtype="grid",
+            )
         column = create_component(
             "grid-item",
             [
@@ -213,6 +219,13 @@ class GridItemCardDirective(SphinxDirective):
     def run(self) -> List[nodes.Node]:
         """Run the directive."""
         self.assert_has_content()
+        if not is_component(self.state_machine.node, "grid-row"):
+            LOGGER.warning(
+                f"The parent of a 'grid-item' should be a 'grid-row' [{WARNING_TYPE}.grid]",
+                location=(self.env.docname, self.lineno),
+                type=WARNING_TYPE,
+                subtype="grid",
+            )
         column = create_component(
             "grid-item",
             [

sphinx_design/tabs.py

@@ -82,6 +82,13 @@ class TabItemDirective(SphinxDirective):
     def run(self) -> List[nodes.Node]:
         """Run the directive."""
         self.assert_has_content()
+        if not is_component(self.state_machine.node, "tab-set"):
+            LOGGER.warning(
+                f"The parent of a 'tab-item' should be a 'tab-set' [{WARNING_TYPE}.tab]",
+                location=(self.env.docname, self.lineno),
+                type=WARNING_TYPE,
+                subtype="tab",
+            )
         tab_item = create_component(
             "tab-item",
             classes=["sd-tab-item"] + self.options.get("class", []),