Skip to content

Commit 9193ffe

Browse files
provide option to view example notebooks in browser
1 parent 2c92222 commit 9193ffe

4 files changed

Lines changed: 15 additions & 6 deletions

File tree

docs/examples/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ Table below describes what can be found within each interactive notebook
1111

1212
| Thumbnail | Title | Description | Notebook |
1313
|-----------|-------|-------------|----------|
14-
| ![compendium_thumb](thumbnails/cdippy-compendium.png) | **Compendium Plot** | Visualize common CDIP parameters over time | [`cdippy-compendium.ipynb`](cdippy-compendium.ipynb) |
15-
| ![sst_thumb](thumbnails/cdippy-sst.png) | **Sea Surface Temperature Plot** | Visualize CDIP SST over time | [`cdippy-sst.ipynb`](cdippy-sst.ipynb) |
16-
| ![boxplot_thumb](thumbnails/cdippy-boxplot.png) | **Wave Height Seasonal Boxplot** | Compute statistics and visualize CDIP wave heights | [`cdippy-boxplot.ipynb`](cdippy-boxplot.ipynb) |
17-
| ![xyz_thumb](thumbnails/cdippy-xyz.png) | **XYZ Displacements Plot** | Access and visualize CDIP xyz displacement data | [`cdippy-xyz.ipynb`](cdippy-xyz.ipynb) |
18-
| ![spectrum1d_thumb](thumbnails/cdippy-spectrum1d.png) | **Wave Spectrum 1D Plot** | Access and visualize CDIP 1-D wave spectra data | [`cdippy-spectrum1d.ipynb`](cdippy-spectrum1d.ipynb) |
19-
| ![spectrum2d_thumb](thumbnails/cdippy-spectrum2d.png) | **Wave Spectrum 2D Plot** | Access and visualize CDIP 2-D wave spectra data | [`cdippy-spectrum2d.ipynb`](cdippy-spectrum2d.ipynb) |
14+
| ![compendium_thumb](thumbnails/cdippy-compendium.png) | **Compendium Plot** | Visualize common CDIP parameters over time | [📖 View](cdippy-compendium.ipynb) <br> [⬇️ Download](cdippy-compendium.ipynb){:download} |
15+
| ![sst_thumb](thumbnails/cdippy-sst.png) | **Sea Surface Temperature Plot** | Visualize CDIP SST over time | [📖 View](cdippy-sst.ipynb) <br> [⬇️ Download](cdippy-sst.ipynb){:download} |
16+
| ![boxplot_thumb](thumbnails/cdippy-boxplot.png) | **Wave Height Seasonal Boxplot** | Compute statistics and visualize CDIP wave heights | [📖 View](cdippy-boxplot.ipynb) <br> [⬇️ Download](cdippy-boxplot.ipynb){:download} |
17+
| ![xyz_thumb](thumbnails/cdippy-xyz.png) | **XYZ Displacements Plot** | Access and visualize CDIP xyz displacement data | [📖 View](cdippy-xyz.ipynb) <br> [⬇️ Download](cdippy-xyz.ipynb){:download} |
18+
| ![spectrum1d_thumb](thumbnails/cdippy-spectrum1d.png) | **Wave Spectrum 1D Plot** | Access and visualize CDIP 1-D wave spectra data | [📖 View](cdippy-spectrum1d.ipynb) <br> [⬇️ Download](cdippy-spectrum1d.ipynb){:download} |
19+
| ![spectrum2d_thumb](thumbnails/cdippy-spectrum2d.png) | **Wave Spectrum 2D Plot** | Access and visualize CDIP 2-D wave spectra data | [📖 View](cdippy-spectrum2d.ipynb) <br> [⬇️ Download](cdippy-spectrum2d.ipynb){:download} |
2020

mkdocs.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
11
site_name: CDIPpy Docs
22

3+
# theme:
4+
# name: material
5+
6+
markdown_extensions:
7+
- attr_list
8+
39
plugins:
410
- macros
511
- search
12+
- mkdocs-jupyter
613
- mkdocstrings:
714
handlers:
815
python:

pyproject.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,9 @@ dev = [
3434
"coverage",
3535
"flake8",
3636
"mkdocs",
37+
"mkdocs-jupyter",
3738
"mkdocs-macros-plugin",
39+
"mkdocs-material",
3840
"mkdocstrings[python]",
3941
"mkdocs-material",
4042
"mkdocstrings[python]",

0 commit comments

Comments
 (0)