add example

README.md

@@ -52,6 +52,7 @@ This package provides tools to read, process, and analyze several key solar and
     - OMNI: `SWOMNI`
     - SWIFT: `SWSWIFTEnsemble`
     - Combined: `read_solar_wind_from_multiple_models`
+  - **Example notebook:** <a href="docs/examples/solar_wind_example.ipynb">docs/examples/solar_wind_example.ipynb</a>
 
 Each index can be accessed via these dedicated reader classes, which handle downloading and read methods. See the code in `swvo/io` or API documentation for details on each index's implementation.
 
@@ -72,4 +73,4 @@ or it can be installed directly from PyPI:
 uv pip install swvo
 ```
 
-All the above `uv` commands assume you have `uv` installed, if not then remove `uv` prefix from the commands and run them directly.
+All the above `uv` commands assume you have `uv` installed, if not then remove `uv` prefix from the commands and run them directly.

docs/conf.py

@@ -30,6 +30,7 @@
     "sphinx.ext.napoleon",
     "sphinx.ext.autosectionlabel",
     "myst_parser",
+    "nbsphinx",
     "sphinx_copybutton",
     "sphinx.ext.imgconverter",
     "sphinx_github_changelog",
@@ -56,6 +57,7 @@
     "tasklist",
 ]
 autosummary_generate = True
+nbsphinx_execute = "auto"
 
 autodoc_default_options = {
     "members": ("member-order,inherited-members, show-inheritance"),

docs/index.rst

@@ -22,5 +22,6 @@ User Guide
 .. toctree::
    :maxdepth: 1
 
+   Examples <examples/solar_wind_example>
    Changelog <changelog>
-   Contributing Guide <CONTRIBUTING>
+   Contributing Guide <CONTRIBUTING>

docs/requirements.txt

@@ -11,4 +11,5 @@ alabaster
 docutils
 imagesize
 numpydoc
-linkify-it-py
+linkify-it-py
+nbsphinx