Fix Sphinx gallery header for docs CI

skilledwolf · skilledwolf · commit f178763922c4 · 2026-04-01T14:10:16.000-03:00
diff --git a/.gitignore b/.gitignore
@@ -65,4 +65,3 @@ Roadmap.local.md
 docs/_build/
 docs/generated/
 docs/sg_execution_times.rst
-docs/examples/README.txt
diff --git a/docs/conf.py b/docs/conf.py
@@ -29,7 +29,7 @@
 ]
 
 templates_path = ["_templates"]
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "examples/README.md"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "examples/README.rst"]
 
 myst_enable_extensions = [
     "amsmath",
diff --git a/docs/examples/README.rst b/docs/examples/README.rst
@@ -0,0 +1,7 @@
+Worked examples
+===============
+
+These examples are intentionally small and physics-facing.
+
+- The plane-wave examples plot diagonal form factors and selected exchange-kernel channels.
+- The pseudopotential example plots a standard lowest-Landau-level Coulomb benchmark.

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@`
`29`	`29`	`]`
`30`	`30`
`31`	`31`	`templates_path = ["_templates"]`
`32`		`-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "examples/README.md"]`
	`32`	`+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "examples/README.rst"]`
`33`	`33`
`34`	`34`	`myst_enable_extensions = [`
`35`	`35`	`"amsmath",`