diff --git a/doc/source/_static/thumbnails/101_getting_started.png b/doc/source/_static/thumbnails/101_getting_started.png new file mode 100644 index 0000000000..5c81f7f63b Binary files /dev/null and b/doc/source/_static/thumbnails/101_getting_started.png differ diff --git a/doc/source/conf.py b/doc/source/conf.py index e7f365641d..7afdef0b89 100644 --- 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 index 2a5ed619e5..325a34d6d2 100644 --- 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 index 6fb6aec42f..496ecb1741 100644 --- 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 index 1bc1d5099f..d914d11953 100644 --- 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