♻️ REFACTOR: test_sd_hide_root_title to sd_hide_title front-matter

Author: chrisjsewell

docs/css_classes.md

@@ -292,3 +292,5 @@ Add CSS animations when loading elements using the `sd-animate-{name}` classes:
 - `sd-animate-grow100`
 - `sd-animate-grow50`
 - `sd-animate-grow50-rot20`
+
+See [uxdesign.cc](https://uxdesign.cc/the-ultimate-guide-to-proper-use-of-animation-in-ux-10bd98614fa9) and [material.io](https://material.io/design/motion/understanding-motion.html#user-education) for good guides to animation.

docs/get_started.md

@@ -26,11 +26,22 @@ myst_enable_extensions = ["colon_fence"]
 
 ## Configuration
 
-To hide the the title header on the landing page (i.e. root document), add the following to your `conf.py`:
-
-```python
-sd_hide_root_title = True
+To hide the the title header of a page, add the to the top of the page:
+
+::::{tab-set}
+:::{tab-item} MyST Markdown
+```markdown
+---
+sd_hide_title: true
+---
+```
+:::
+:::{tab-item} RestructuredText
+```rst
+:sd_hide_title:
 ```
+:::
+::::
 
 ## Supported browsers
 

docs/index.md

@@ -1,3 +1,7 @@
+---
+sd_hide_title: true
+---
+
 # sphinx-design
 
 ::::{grid}
@@ -127,4 +131,6 @@ Change the default colors and other CSS.
 
 ::::
 
+-----------
+
 Created with inspiration from [Bootstrap](https://getbootstrap.com/) (v5), [Material Design](https://material.io) and [Material-UI](https://material-ui.com/) design frameworks.

sphinx_design/extension.py

@@ -27,7 +27,6 @@
 
 def setup_extension(app: Sphinx) -> None:
     """Set up the sphinx extension."""
-    app.add_config_value("sd_hide_root_title", False, "env")
     app.connect("builder-inited", update_css_js)
     app.connect("env-updated", update_css_links)
     # we override container html visitors, to stop the default behaviour
@@ -143,15 +142,15 @@ class AddFirstTitleCss(SphinxTransform):
     default_priority = 699  # priority main
 
     def apply(self):
-        if not self.app.config.sd_hide_root_title:
+        hide = False
+        for docinfo in self.document.traverse(nodes.docinfo):
+            for name in docinfo.traverse(nodes.field_name):
+                if name.astext() == "sd_hide_title":
+                    hide = True
+                    break
+            break
+        if not hide:
             return
-        # from sphinx 4 master_doc is deprecated for root_doc
-        try:
-            if self.env.docname != self.config.root_doc:
-                return
-        except Exception:
-            if self.env.docname != self.config.master_doc:
-                return
         for section in self.document.traverse(nodes.section):
             if isinstance(section.children[0], nodes.title):
                 if "classes" in section.children[0]:

tests/test_snippets.py

@@ -105,18 +105,33 @@ def test_snippets_myst_post(
     )
 
 
-def test_sd_hide_root_title(
+def test_sd_hide_title_rst(
     sphinx_builder: Callable[..., SphinxBuilder], file_regression
 ):
     """Test that the root title is hidden."""
-    builder = sphinx_builder(
-        conf_kwargs={"extensions": ["sphinx_design"], "sd_hide_root_title": True}
-    )
-    content = "Heading\n-------" + "\n\ncontent"
+    builder = sphinx_builder()
+    content = ":sd_hide_title:\n\nHeading\n-------\n\ncontent"
     builder.src_path.joinpath("index.rst").write_text(content, encoding="utf8")
     builder.build()
     file_regression.check(
         builder.get_doctree("index", post_transforms=False).pformat(),
+        basename="sd_hide_title",
+        extension=".xml",
+        encoding="utf8",
+    )
+
+
+def test_sd_hide_title_myst(
+    sphinx_builder: Callable[..., SphinxBuilder], file_regression
+):
+    """Test that the root title is hidden."""
+    builder = sphinx_builder()
+    content = "---\nsd_hide_title: true\n---\n\n# Heading\n\ncontent"
+    builder.src_path.joinpath("index.md").write_text(content, encoding="utf8")
+    builder.build()
+    file_regression.check(
+        builder.get_doctree("index", post_transforms=False).pformat(),
+        basename="sd_hide_title",
         extension=".xml",
         encoding="utf8",
     )