REFACTOR: Edb configuration documentation (#707)

* REFACTOR: edb configuration documentation * minor fix * add gallery pictures * FIX: move png into /thumbnails * FIX: use thumbnails * FIX: minor * MISC: Auto fixes from pre-commit.com hooks For more information, see https://pre-commit.ci * DOCS: Update configuration thumbnail path * DOCS: Update path to thumbnails --------- Co-authored-by: ring630 <@gmail.com> Co-authored-by: Sébastien Morais <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Sebastien Morais <[email protected]>
ansys · Aug 12, 2024 · d98bb6d · d98bb6d
1 parent f9032d3
commit d98bb6d
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 9 deletions.
diff --git a/doc/source/_static/thumbnails/101_getting_started.png b/doc/source/_static/thumbnails/101_getting_started.png
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -360,9 +360,13 @@ def setup(app):
 nbsphinx_allow_errors = False
 
 # Sphinx gallery customization
-# nbsphinx_thumbnails = {
-#     "examples/legacy_standalone/00_EDB_Create_VIA": "_static/thumbnails/diff_via.png",
-# }
+nbsphinx_thumbnails = {
+    "examples/use_configuration/set_up_edb_for_signal_integrity_analysis": "_static/thumbnails/101_getting_started.png",
+    "examples/use_configuration/import_stackup": "_static/thumbnails/101_getting_started.png",
+    "examples/use_configuration/import_material": "_static/thumbnails/101_getting_started.png",
+    "examples/use_configuration/import_ports": "_static/thumbnails/101_getting_started.png",
+    "examples/use_configuration/import_setup_ac": "_static/thumbnails/101_getting_started.png",
+}
 
 nbsphinx_custom_formats = {
     ".py": ["jupytext.reads", {"fmt": ""}],

diff --git a/examples/use_configuration/import_ports.py b/examples/use_configuration/import_ports.py
@@ -1,6 +1,7 @@
 # # Import Ports
 # This example shows how to import ports. In this example, we are going to
-# - Download a example board
+#
+# - Download an example board
 # - Create a configuration file
 #   - Add a circuit port between two nets
 #   - Add a circuit port between two pins

diff --git a/examples/use_configuration/import_setup_ac.py b/examples/use_configuration/import_setup_ac.py
@@ -1,5 +1,6 @@
 # # Import Setup AC
 # This example shows how to import SIwave, HFSS setups for AC analysis. In this example, we are going to
+#
 # - Download an example board
 # - Create a configuration file
 #   - add setups

diff --git a/examples/use_configuration/index.rst b/examples/use_configuration/index.rst
@@ -2,10 +2,19 @@ Use configuration
 ~~~~~~~~~~~~~~~~~
 The following examples illustrate the use of configuration files in PyEDB.
 
+End-to-end workflow
+-------------------
+
+.. nbgallery::
+
+        set_up_edb_for_signal_integrity_analysis.py
+
+Step explanation
+-------------------------
+
 .. nbgallery::
 
-    set_up_edb_for_signal_integrity_analysis.py
-    import_stackup.py
-    import_material.py
-    import_ports.py
-    import_setup_ac.py
+        import_stackup.py
+        import_material.py
+        import_ports.py
+        import_setup_ac.py